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

package/sdk/platform/User/UserPlatformModel.js

@@ -1,10 +1,23 @@
 const Joi = require("joi");
 
 /**
- * @typedef SuccessMessageResponse
+ * @typedef SuccessMessage
  * @property {string} [success]
  */
 
+/**
+ * @typedef UserAttributeDefinitionList
+ * @property {UserAttributeDefinition[]} [items] - Array of user attribute
+ *   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.
@@ -13,7 +26,14 @@ const Joi = require("joi");
  * @property {string} [description] - The description of the attribute.
  * @property {string} [application_id] - The application ID.
  * @property {string} [type] - The attribute type.
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
+ * @property {string} [icon] - Optional icon representation for this attribute.
+ *   Defaults to an empty string.
+ * @property {string[]} [ordering_channels] - Ordering Channels where this
+ *   attribute should be visible.
+ * @property {AttributeMaskingProperties} [masking]
+ * @property {AttributeRegistrationProperties} [registration]
+ * @property {boolean} [is_multi_value] - Indicates if this attribute can accept
+ *   multiple values.
  * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
  * @property {boolean} [encrypted] - Whether the attribute is encrypted.
  * @property {boolean} [pinned] - Whether the attribute is pinned.
@@ -23,17 +43,25 @@ 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
  */
 
 /**
- * @typedef UserAttributeDefinitionResponse
+ * @typedef UserAttributeDefinitionDetails
  * @property {string} [_id] - The unique identifier for the attribute definition.
  * @property {string} [name] - The attribute name.
  * @property {string} [slug] - The attribute key.
  * @property {string} [description] - The description of the attribute.
  * @property {string} [application_id] - The application ID.
  * @property {string} [type] - The attribute type.
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
+ * @property {string} [icon] - Optional icon representation for this attribute.
+ *   Defaults to an empty string.
+ * @property {string[]} [ordering_channels] - Ordering Channels where this
+ *   attribute should be visible.
+ * @property {AttributeMaskingProperties} [masking]
+ * @property {AttributeRegistrationProperties} [registration]
+ * @property {boolean} [is_multi_value] - Indicates if this attribute can accept
+ *   multiple values.
  * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
  * @property {boolean} [encrypted] - Whether the attribute is encrypted.
  * @property {boolean} [pinned] - Whether the attribute is pinned.
@@ -47,6 +75,22 @@ const Joi = require("joi");
  *   attribute definition.
  */
 
+/**
+ * @typedef AttributeMaskingProperties
+ * @property {boolean} [enabled] - Indicates if PII masking is editable for this
+ *   attribute.
+ * @property {string} [type] - Indicates the PII masking options available
+ *   default or others
+ */
+
+/**
+ * @typedef AttributeRegistrationProperties
+ * @property {boolean} [enabled] - Indicates if an attribute is editable when
+ *   customer registers for a storefront.
+ * @property {string} [type] - Indicates if this attribute is mandatory or
+ *   optional when customer registers for a storefront.
+ */
+
 /**
  * @typedef UserAttributeDefinitionValidation
  * @property {string} [type] - The type of validation.
@@ -54,20 +98,47 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef UserAttributeResponse
+ * @typedef BulkUserAttribute
+ * @property {boolean} [success] - This describes the status of the API response
+ * @property {UserAttribute[]} [attributes]
+ */
+
+/**
+ * @typedef UserAttribute
  * @property {string} [_id] - The unique identifier for the attribute definition.
  * @property {string} [name] - The name of user attribute definition.
  * @property {string} [user_id] - The unique identifier for the user.
  * @property {string} [application_id] - The application ID.
+ * @property {string} [user_attribute_definition_id] - The unique id of the
+ *   attribute definition.
+ * @property {string} [created_at] - The time when attribute value is created
+ *   for a user in ISO format.
+ * @property {string} [updated_at] - The time when attribute value is updated
+ *   for a user in ISO format.
  * @property {string} [type] - The attribute type.
- * @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
+ * @property {boolean} [customer_overridden] - Whether the attribute is customer-editable.
  * @property {Object} [attribute]
  * @property {string} [updated_by]
  */
 
 /**
- * @typedef CreateUserAttributeRequest
- * @property {boolean} [customer_overriden]
+ * @typedef CreateBulkUserAttribute
+ * @property {BulkUserAttributeRequestBody[]} attributes - This is an array of
+ *   objects containing id of attribute definitions and the respective values to
+ *   created or updated
+ */
+
+/**
+ * @typedef BulkUserAttributeRequestBody
+ * @property {string} definition_id - Theis is an unique id of user attribute definition
+ * @property {Object} value - Attribute values to be create or updated. Can be a
+ *   single value or an array of values. Types supported: string, number, array
+ *   of string, or array of number.
+ */
+
+/**
+ * @typedef CreateUserAttribute
+ * @property {boolean} [customer_overridden]
  * @property {Object} [attribute]
  */
 
@@ -76,8 +147,15 @@ const Joi = require("joi");
  * @property {string} [name]
  * @property {string} [slug]
  * @property {string} [description]
- * @property {string} [type]
- * @property {boolean} [multi_value]
+ * @property {string} [type] - The attribute type.
+ * @property {string} [icon] - Optional icon representation for this attribute.
+ *   Defaults to an empty string.
+ * @property {string[]} [ordering_channels] - Ordering Channels where this
+ *   attribute should be visible.
+ * @property {AttributeMaskingProperties} [masking]
+ * @property {AttributeRegistrationProperties} [registration]
+ * @property {boolean} [is_multi_value] - Indicates if this attribute can accept
+ *   multiple values.
  * @property {boolean} [customer_editable]
  * @property {boolean} [encrypted]
  * @property {boolean} [pinned]
@@ -86,6 +164,71 @@ const Joi = require("joi");
  * @property {Object[]} [validations]
  */
 
+/**
+ * @typedef CreateStoreFrontUsersPayload
+ * @property {string} absolute_url - A valid URL linking to the file containing
+ *   user data to be imported.
+ * @property {string} file_format - The format of the file containing the user's
+ *   data. Supported formats are CSV and XLSX.
+ * @property {string} relative_url - A valid relative path to the file within
+ *   the storage system. This path should not include the base URL or domain and
+ *   must conform to the storage structure
+ */
+
+/**
+ * @typedef BulkUserExportSchema
+ * @property {string} file_format - The format of the file in which you want to
+ *   export data. Supported formats are CSV and XLSX.
+ */
+
+/**
+ * @typedef BulkActionModel
+ * @property {string} _id - The Job ID associated with an Import or Export Job
+ * @property {string} file_name - The name of the file
+ * @property {string} file_format - The format of the uploaded file (e.g., CSV, XLSX).
+ * @property {string} action_type - The type of bulk action being performed
+ *   (e.g., import, export).
+ * @property {CreatedBySchema} created_by
+ * @property {BulkActionCountSchema} [count]
+ * @property {string} [status] - The current status of the bulk action.
+ * @property {BulkActionLinkSchema} [links]
+ * @property {string} application_id - The unique identifier of the associated
+ *   application.
+ * @property {string} company_id - The unique identifier of the company
+ *   associated with the bulk action.
+ * @property {string} [created_at] - The timestamp when the bulk action was created.
+ * @property {string} [updated_at] - The timestamp when the bulk action was last updated.
+ */
+
+/**
+ * @typedef CreatedBySchema
+ * @property {string} name - The name of the user who initiated the operation.
+ * @property {string} user_id - A unique identifier for the user who initiated
+ *   the operation.
+ */
+
+/**
+ * @typedef BulkActionLinkSchema
+ * @property {FileLinks} [file]
+ * @property {FileLinks} [error]
+ */
+
+/**
+ * @typedef FileLinks
+ * @property {string} [absolute_url] - The full URL of the file, including the
+ *   domain and protocol, allowing direct access to the file from any location.
+ * @property {string} [relative_url] - The relative path to the file within the
+ *   storage system, excluding the base URL or domain. This path is specific to
+ *   the storage structure.
+ */
+
+/**
+ * @typedef BulkActionCountSchema
+ * @property {number} [total] - The total number of items to be processed.
+ * @property {number} [success] - The number of successfully processed items.
+ * @property {number} [error] - The number of items that failed to process.
+ */
+
 /**
  * @typedef BlockUserRequestSchema
  * @property {boolean} [status]
@@ -131,13 +274,20 @@ const Joi = require("joi");
  * @property {PaginationSchema} [page]
  */
 
+/**
+ * @typedef BulkActionPaginationSchema
+ * @property {BulkActionModel[]} [items] - Array of Bulk Action Documents
+ * @property {PaginationSchema} [page]
+ */
+
 /**
  * @typedef PaginationSchema
- * @property {number} [size]
- * @property {number} [item_total]
- * @property {boolean} [has_next]
- * @property {string} [type]
- * @property {number} [current]
+ * @property {number} [size] - The number of items per page.
+ * @property {number} [total] - The total number of items across all pages.
+ * @property {number} [item_total] - The total number of items across all pages.
+ * @property {boolean} [has_next] - Indicates whether there are more pages to retrieve.
+ * @property {string} [type] - The type of pagination used (eg Number).
+ * @property {number} [current] - The current page number.
  */
 
 /**
@@ -218,9 +368,92 @@ const Joi = require("joi");
 
 /**
  * @typedef ConditionsSchema
- * @property {string} [user_attribute_definition_id]
- * @property {string} [type]
- * @property {string} [value]
+ * @property {string} [user_attribute_definition_id] - ID of the user attribute
+ *   definition used in the condition
+ * @property {string} [type] - Type of condition to apply on the attribute value.
+ * @property {Object} [value] - Value of the condition
+ * @property {boolean} [ignore_year] - Indicates if the year should be ignored
+ *   for the condition
+ */
+
+/**
+ * @typedef DeleteBulkUserAttribute
+ * @property {string[]} [definition_ids] - List of user attribute definition IDs
+ *   for which the corresponding values should be deleted.
+ */
+
+/**
+ * @typedef UserAttributeFilter
+ * @property {UserAttributeFilterQuery} [query]
+ */
+
+/**
+ * @typedef UserAttributeFilterQuery
+ * @property {string} type - Logical condition type to apply between multiple
+ *   attribute filters.
+ * @property {number} limit - Number of results to return per page.
+ * @property {number} page - Page number to fetch.
+ * @property {string} [email] - Filter users by their exact email address.
+ * @property {boolean} [has_email] - Apply a filter to retrieve users who have a
+ *   valid email address specified in their profile.
+ * @property {boolean} [has_phone] - Apply a filter to retrieve users who have a
+ *   valid phone number specified in their profile.
+ * @property {string} [phone] - Filter users by their exact phone number.
+ * @property {string[]} [definition_ids] - List of user attribute definition IDs
+ *   to fetch attributes values available for each user.
+ * @property {UserAttributeFilterRequestConditions[]} conditions - List of
+ *   filtering conditions to apply on user attributes.
+ */
+
+/**
+ * @typedef UserAttributeFilterRequestConditions
+ * @property {string} definition_id - ID of the user attribute definition to filter on.
+ * @property {string} type - Filter operation to apply on the attribute value.
+ *   Supported operations include:
+ *
+ *   - `eq`: Equal to - `ne`: Not equal to - `gt`: Greater than (or is after for
+ *       dates) - `lt`: Less than (or is before for dates) - `gte`: Greater than
+ *       or equal to - `lte`: Less than or equal to - `cnt`: Contains (for
+ *       strings) - `nct`: Does not contain (for strings) - `is`: Matches
+ *       exactly (for strings) - `nis`: Does not match exactly (for strings) -
+ *       `sw`: Starts with (for strings) - `ew`: Ends with (for strings) -
+ *       `btw`: Between two values (for date and datetime types) - `in`: Value
+ *       exists in given list - `nin`: Value does not exist in given list
+ *
+ * @property {Object} value - Values to be used in filtering the attribute. Can
+ *   be a single value or an array of values. Types supported: string, number,
+ *   array of string, or array of number.
+ */
+
+/**
+ * @typedef UserAttributeFiltered
+ * @property {UserAttributeFilteredList[]} [items] - List of user objects that
+ *   match the filter criteria.
+ * @property {PaginationSchema} [page]
+ */
+
+/**
+ * @typedef UserAttributeFilteredList
+ * @property {string} [_id] - Unique ID of the user.
+ * @property {string} [username] - Generated username for the user.
+ * @property {UserPhoneNumbers[]} [phone_numbers] - List of phone numbers
+ *   associated with the user.
+ * @property {UserEmails[]} [emails] - List of emails associated with the user.
+ * @property {string} [gender] - Gender of the user.
+ * @property {boolean} [active] - Whether the user account is active.
+ * @property {boolean} [archive] - Whether the user account is archived.
+ * @property {string} [status] - Status of the user account.
+ * @property {UserAttribute[]} [attributes]
+ * @property {string} [first_name] - First name of the user.
+ * @property {string} [last_name] - Last name of the user.
+ * @property {string} [account_type] - Type of user account.
+ * @property {string} [profile_pic_url] - URL to user's profile picture.
+ * @property {boolean} [has_old_password_hash] - Whether user has legacy password format.
+ * @property {string} [user_id] - Unique user ID.
+ * @property {string} [application_id] - Application ID associated with the user.
+ * @property {boolean} [is_encrypted] - Whether the user data is encrypted.
+ * @property {string} [created_at] - Timestamp of user creation.
+ * @property {string} [updated_at] - Timestamp of last update.
  */
 
 /**
@@ -234,15 +467,17 @@ const Joi = require("joi");
 
 /**
  * @typedef CreateUserRequestSchema
- * @property {string} phone_number
+ * @property {string} [phone_number]
  * @property {string} [email]
  * @property {string} [first_name]
  * @property {string} [last_name]
  * @property {string} [gender]
- * @property {string} username
+ * @property {string} [username]
  * @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").
  */
 
 /**
@@ -368,6 +603,7 @@ const Joi = require("joi");
  * @property {Facebook} [facebook]
  * @property {Accountkit} [account_kit]
  * @property {Google} [google]
+ * @property {Apple} [apple]
  */
 
 /**
@@ -382,6 +618,21 @@ const Joi = require("joi");
  * @property {string} [consent_text]
  */
 
+/**
+ * @typedef GetUserTimeline
+ * @property {string} [delete_on] - Denotes the date on which the user will be deleted
+ * @property {UserTimeline[]} [timeline] - List of user timeline events
+ */
+
+/**
+ * @typedef UserTimeline
+ * @property {string} [date] - Denotes the date at which this event occured
+ * @property {string} [title] - Title of the timeline event
+ * @property {string} [type] - Type of the event, indicating its status
+ * @property {boolean} [visible] - Indicates whether the event should be shown on the UI
+ * @property {string} [sub_title] - Additional information about the event
+ */
+
 /**
  * @typedef Facebook
  * @property {string} [app_id]
@@ -400,6 +651,12 @@ const Joi = require("joi");
  * @property {string} [app_secret]
  */
 
+/**
+ * @typedef Apple
+ * @property {string} [app_id]
+ * @property {string} [redirect_uri]
+ */
+
 /**
  * @typedef SessionExpiry
  * @property {number} [duration]
@@ -433,7 +690,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
@@ -443,6 +700,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]
@@ -478,7 +737,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]
@@ -488,6 +748,7 @@ const Joi = require("joi");
  * @property {string} [updated_at]
  * @property {string} [external_id]
  * @property {string} [rr_id]
+ * @property {UserConsent} [consent]
  */
 
 /**
@@ -500,7 +761,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]
@@ -512,6 +774,8 @@ const Joi = require("joi");
  * @property {string} [rr_id]
  * @property {boolean} [archive]
  * @property {string} [status]
+ * @property {string} [deleted_on]
+ * @property {UserConsent} [consent]
  */
 
 /**
@@ -531,14 +795,48 @@ const Joi = require("joi");
  * @property {boolean} [verified] - Is the email verified.
  */
 
+/**
+ * @typedef UserConsent
+ * @property {PrivacyPolicyConsentSchema} [privacy_policy]
+ */
+
+/**
+ * @typedef DeleteUserGroupSuccess
+ * @property {string} id - ID of the user group that was deleted
+ * @property {boolean} success - Success indicating the user group was deleted
+ *   successfully.
+ */
+
+/**
+ * @typedef PrivacyPolicyConsentSchema
+ * @property {boolean} [value] - Whether the user has consented to the privacy policy
+ * @property {string} [updated_at] - When the consent was last updated
+ */
+
 class UserPlatformModel {
-  /** @returns {SuccessMessageResponse} */
-  static SuccessMessageResponse() {
+  /** @returns {SuccessMessage} */
+  static SuccessMessage() {
     return Joi.object({
       success: Joi.string().allow(""),
     });
   }
 
+  /** @returns {UserAttributeDefinitionList} */
+  static UserAttributeDefinitionList() {
+    return Joi.object({
+      items: Joi.array().items(UserPlatformModel.UserAttributeDefinition()),
+      page: UserPlatformModel.PaginationSchema(),
+    });
+  }
+
+  /** @returns {UserAttributeDefinitionsResponseSchema} */
+  static UserAttributeDefinitionsResponseSchema() {
+    return Joi.object({
+      items: Joi.array().items(UserPlatformModel.UserAttribute()),
+      page: UserPlatformModel.PaginationSchema(),
+    });
+  }
+
   /** @returns {UserAttributeDefinition} */
   static UserAttributeDefinition() {
     return Joi.object({
@@ -548,7 +846,11 @@ class UserPlatformModel {
       description: Joi.string().allow(""),
       application_id: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      multi_value: Joi.boolean(),
+      icon: Joi.string().allow(""),
+      ordering_channels: Joi.array().items(Joi.string().allow("")),
+      masking: UserPlatformModel.AttributeMaskingProperties(),
+      registration: UserPlatformModel.AttributeRegistrationProperties(),
+      is_multi_value: Joi.boolean(),
       customer_editable: Joi.boolean(),
       encrypted: Joi.boolean(),
       pinned: Joi.boolean(),
@@ -558,11 +860,12 @@ class UserPlatformModel {
       created_at: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
       __v: Joi.number(),
+      options: Joi.array().items(Joi.string().allow("")),
     });
   }
 
-  /** @returns {UserAttributeDefinitionResponse} */
-  static UserAttributeDefinitionResponse() {
+  /** @returns {UserAttributeDefinitionDetails} */
+  static UserAttributeDefinitionDetails() {
     return Joi.object({
       _id: Joi.string().allow(""),
       name: Joi.string().allow(""),
@@ -570,7 +873,11 @@ class UserPlatformModel {
       description: Joi.string().allow(""),
       application_id: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      multi_value: Joi.boolean(),
+      icon: Joi.string().allow(""),
+      ordering_channels: Joi.array().items(Joi.string().allow("")),
+      masking: UserPlatformModel.AttributeMaskingProperties(),
+      registration: UserPlatformModel.AttributeRegistrationProperties(),
+      is_multi_value: Joi.boolean(),
       customer_editable: Joi.boolean(),
       encrypted: Joi.boolean(),
       pinned: Joi.boolean(),
@@ -586,6 +893,22 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {AttributeMaskingProperties} */
+  static AttributeMaskingProperties() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {AttributeRegistrationProperties} */
+  static AttributeRegistrationProperties() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+      type: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {UserAttributeDefinitionValidation} */
   static UserAttributeDefinitionValidation() {
     return Joi.object({
@@ -594,25 +917,53 @@ class UserPlatformModel {
     });
   }
 
-  /** @returns {UserAttributeResponse} */
-  static UserAttributeResponse() {
+  /** @returns {BulkUserAttribute} */
+  static BulkUserAttribute() {
+    return Joi.object({
+      success: Joi.boolean(),
+      attributes: Joi.array().items(UserPlatformModel.UserAttribute()),
+    });
+  }
+
+  /** @returns {UserAttribute} */
+  static UserAttribute() {
     return Joi.object({
       _id: Joi.string().allow(""),
       name: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
       application_id: Joi.string().allow(""),
+      user_attribute_definition_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      customer_overriden: Joi.boolean(),
-      attribute: Joi.any(),
+      customer_overridden: Joi.boolean(),
+      attribute: Joi.object().pattern(/\S/, Joi.any()),
       updated_by: Joi.string().allow(""),
     });
   }
 
-  /** @returns {CreateUserAttributeRequest} */
-  static CreateUserAttributeRequest() {
+  /** @returns {CreateBulkUserAttribute} */
+  static CreateBulkUserAttribute() {
+    return Joi.object({
+      attributes: Joi.array()
+        .items(UserPlatformModel.BulkUserAttributeRequestBody())
+        .required(),
+    });
+  }
+
+  /** @returns {BulkUserAttributeRequestBody} */
+  static BulkUserAttributeRequestBody() {
+    return Joi.object({
+      definition_id: Joi.string().allow("").required(),
+      value: Joi.any().required(),
+    });
+  }
+
+  /** @returns {CreateUserAttribute} */
+  static CreateUserAttribute() {
     return Joi.object({
-      customer_overriden: Joi.boolean(),
-      attribute: Joi.any(),
+      customer_overridden: Joi.boolean(),
+      attribute: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -623,7 +974,11 @@ class UserPlatformModel {
       slug: Joi.string().allow(""),
       description: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      multi_value: Joi.boolean(),
+      icon: Joi.string().allow(""),
+      ordering_channels: Joi.array().items(Joi.string().allow("")),
+      masking: UserPlatformModel.AttributeMaskingProperties(),
+      registration: UserPlatformModel.AttributeRegistrationProperties(),
+      is_multi_value: Joi.boolean(),
       customer_editable: Joi.boolean(),
       encrypted: Joi.boolean(),
       pinned: Joi.boolean(),
@@ -633,6 +988,73 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {CreateStoreFrontUsersPayload} */
+  static CreateStoreFrontUsersPayload() {
+    return Joi.object({
+      absolute_url: Joi.string().allow("").required(),
+      file_format: Joi.string().allow("").required(),
+      relative_url: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {BulkUserExportSchema} */
+  static BulkUserExportSchema() {
+    return Joi.object({
+      file_format: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {BulkActionModel} */
+  static BulkActionModel() {
+    return Joi.object({
+      _id: Joi.string().allow("").required(),
+      file_name: Joi.string().allow("").required(),
+      file_format: Joi.string().allow("").required(),
+      action_type: Joi.string().allow("").required(),
+      created_by: UserPlatformModel.CreatedBySchema().required(),
+      count: UserPlatformModel.BulkActionCountSchema(),
+      status: Joi.string().allow(""),
+      links: UserPlatformModel.BulkActionLinkSchema(),
+      application_id: Joi.string().allow("").required(),
+      company_id: Joi.string().allow("").required(),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CreatedBySchema} */
+  static CreatedBySchema() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+      user_id: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {BulkActionLinkSchema} */
+  static BulkActionLinkSchema() {
+    return Joi.object({
+      file: UserPlatformModel.FileLinks(),
+      error: UserPlatformModel.FileLinks(),
+    });
+  }
+
+  /** @returns {FileLinks} */
+  static FileLinks() {
+    return Joi.object({
+      absolute_url: Joi.string().allow(""),
+      relative_url: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {BulkActionCountSchema} */
+  static BulkActionCountSchema() {
+    return Joi.object({
+      total: Joi.number(),
+      success: Joi.number(),
+      error: Joi.number(),
+    });
+  }
+
   /** @returns {BlockUserRequestSchema} */
   static BlockUserRequestSchema() {
     return Joi.object({
@@ -694,10 +1116,19 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {BulkActionPaginationSchema} */
+  static BulkActionPaginationSchema() {
+    return Joi.object({
+      items: Joi.array().items(UserPlatformModel.BulkActionModel()),
+      page: UserPlatformModel.PaginationSchema(),
+    });
+  }
+
   /** @returns {PaginationSchema} */
   static PaginationSchema() {
     return Joi.object({
       size: Joi.number(),
+      total: Joi.number(),
       item_total: Joi.number(),
       has_next: Joi.boolean(),
       type: Joi.string().allow(""),
@@ -736,7 +1167,7 @@ class UserPlatformModel {
       info: Joi.string().allow(""),
       request_id: Joi.string().allow(""),
       error: Joi.string().allow(""),
-      meta: Joi.any(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       authenticated: Joi.boolean(),
     });
   }
@@ -804,7 +1235,81 @@ class UserPlatformModel {
     return Joi.object({
       user_attribute_definition_id: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      value: Joi.string().allow(""),
+      value: Joi.object().pattern(/\S/, Joi.any()),
+      ignore_year: Joi.boolean(),
+    });
+  }
+
+  /** @returns {DeleteBulkUserAttribute} */
+  static DeleteBulkUserAttribute() {
+    return Joi.object({
+      definition_ids: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  /** @returns {UserAttributeFilter} */
+  static UserAttributeFilter() {
+    return Joi.object({
+      query: UserPlatformModel.UserAttributeFilterQuery(),
+    });
+  }
+
+  /** @returns {UserAttributeFilterQuery} */
+  static UserAttributeFilterQuery() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+      limit: Joi.number().required(),
+      page: Joi.number().required(),
+      email: Joi.string().allow(""),
+      has_email: Joi.boolean(),
+      has_phone: Joi.boolean(),
+      phone: Joi.string().allow(""),
+      definition_ids: Joi.array().items(Joi.string().allow("")),
+      conditions: Joi.array()
+        .items(UserPlatformModel.UserAttributeFilterRequestConditions())
+        .required(),
+    });
+  }
+
+  /** @returns {UserAttributeFilterRequestConditions} */
+  static UserAttributeFilterRequestConditions() {
+    return Joi.object({
+      definition_id: Joi.string().allow("").required(),
+      type: Joi.string().allow("").required(),
+      value: Joi.object().pattern(/\S/, Joi.any()).required(),
+    });
+  }
+
+  /** @returns {UserAttributeFiltered} */
+  static UserAttributeFiltered() {
+    return Joi.object({
+      items: Joi.array().items(UserPlatformModel.UserAttributeFilteredList()),
+      page: UserPlatformModel.PaginationSchema(),
+    });
+  }
+
+  /** @returns {UserAttributeFilteredList} */
+  static UserAttributeFilteredList() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      username: Joi.string().allow(""),
+      phone_numbers: Joi.array().items(UserPlatformModel.UserPhoneNumbers()),
+      emails: Joi.array().items(UserPlatformModel.UserEmails()),
+      gender: Joi.string().allow(""),
+      active: Joi.boolean(),
+      archive: Joi.boolean(),
+      status: Joi.string().allow(""),
+      attributes: Joi.array().items(UserPlatformModel.UserAttribute()),
+      first_name: Joi.string().allow(""),
+      last_name: Joi.string().allow(""),
+      account_type: Joi.string().allow(""),
+      profile_pic_url: Joi.string().allow(""),
+      has_old_password_hash: Joi.boolean(),
+      user_id: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      is_encrypted: Joi.boolean(),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
     });
   }
 
@@ -822,15 +1327,16 @@ class UserPlatformModel {
   /** @returns {CreateUserRequestSchema} */
   static CreateUserRequestSchema() {
     return Joi.object({
-      phone_number: Joi.string().allow("").required(),
+      phone_number: Joi.string().allow(""),
       email: Joi.string().allow(""),
       first_name: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
       gender: Joi.string().allow(""),
-      username: Joi.string().allow("").required(),
-      meta: Joi.any(),
+      username: Joi.string().allow(""),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       external_id: Joi.string().allow(""),
       rr_id: Joi.string().allow(""),
+      dob: Joi.string().allow(""),
     });
   }
 
@@ -990,6 +1496,7 @@ class UserPlatformModel {
       facebook: UserPlatformModel.Facebook(),
       account_kit: UserPlatformModel.Accountkit(),
       google: UserPlatformModel.Google(),
+      apple: UserPlatformModel.Apple(),
     });
   }
 
@@ -1009,6 +1516,25 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {GetUserTimeline} */
+  static GetUserTimeline() {
+    return Joi.object({
+      delete_on: Joi.string().allow(""),
+      timeline: Joi.array().items(UserPlatformModel.UserTimeline()),
+    });
+  }
+
+  /** @returns {UserTimeline} */
+  static UserTimeline() {
+    return Joi.object({
+      date: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      visible: Joi.boolean(),
+      sub_title: Joi.string().allow("").allow(null),
+    });
+  }
+
   /** @returns {Facebook} */
   static Facebook() {
     return Joi.object({
@@ -1033,6 +1559,14 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {Apple} */
+  static Apple() {
+    return Joi.object({
+      app_id: Joi.string().allow(""),
+      redirect_uri: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SessionExpiry} */
   static SessionExpiry() {
     return Joi.object({
@@ -1079,10 +1613,11 @@ 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(""),
-      meta: Joi.any(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       phone_numbers: Joi.array().items(UserPlatformModel.UserPhoneNumbers()),
       emails: Joi.array().items(UserPlatformModel.UserEmails()),
     });
@@ -1115,7 +1650,7 @@ class UserPlatformModel {
       application_id: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
       first_name: Joi.string().allow(""),
-      meta: Joi.any(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       last_name: Joi.string().allow(""),
       phone_numbers: Joi.array().items(UserPlatformModel.PhoneNumber()),
       emails: Joi.array().items(UserPlatformModel.Email()),
@@ -1130,6 +1665,7 @@ class UserPlatformModel {
       updated_at: Joi.string().allow(""),
       external_id: Joi.string().allow(""),
       rr_id: Joi.string().allow(""),
+      consent: UserPlatformModel.UserConsent(),
     });
   }
 
@@ -1139,7 +1675,7 @@ class UserPlatformModel {
       application_id: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
       first_name: Joi.string().allow(""),
-      meta: Joi.any(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       last_name: Joi.string().allow(""),
       phone_numbers: Joi.array().items(UserPlatformModel.PhoneNumber()),
       emails: Joi.array().items(UserPlatformModel.Email()),
@@ -1156,6 +1692,8 @@ class UserPlatformModel {
       rr_id: Joi.string().allow(""),
       archive: Joi.boolean(),
       status: Joi.string().allow(""),
+      deleted_on: Joi.string().allow(""),
+      consent: UserPlatformModel.UserConsent(),
     });
   }
 
@@ -1179,5 +1717,28 @@ class UserPlatformModel {
       verified: Joi.boolean(),
     });
   }
+
+  /** @returns {UserConsent} */
+  static UserConsent() {
+    return Joi.object({
+      privacy_policy: UserPlatformModel.PrivacyPolicyConsentSchema(),
+    });
+  }
+
+  /** @returns {DeleteUserGroupSuccess} */
+  static DeleteUserGroupSuccess() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      success: Joi.boolean().required(),
+    });
+  }
+
+  /** @returns {PrivacyPolicyConsentSchema} */
+  static PrivacyPolicyConsentSchema() {
+    return Joi.object({
+      value: Joi.boolean(),
+      updated_at: Joi.string().allow(""),
+    });
+  }
 }
 module.exports = UserPlatformModel;