export = UserPlatformModel;
/**
 * @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.
 * @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 {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.
 * @property {number} [pin_order] - The order in which the attribute is pinned.
 * @property {Object[]} [validations]
 * @property {boolean} [is_locked] - Whether the attribute is locked.
 * @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
 * @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 {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.
 * @property {number} [pin_order] - The order in which the attribute is pinned.
 * @property {UserAttributeDefinitionValidation[]} [validations]
 * @property {boolean} [is_locked] - Whether the attribute is locked.
 * @property {string} [created_by] - The user who created the attribute.
 * @property {string} [updated_by] - The user who last updated the attribute.
 * @property {string} [created_at] - The creation date of the attribute definition.
 * @property {string} [modified_at] - The last modification date of the
 *   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.
 * @property {Object} [value] - The validation value.
 */
/**
 * @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_overridden] - Whether the attribute is customer-editable.
 * @property {Object} [attribute]
 * @property {string} [updated_by]
 */
/**
 * @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]
 */
/**
 * @typedef CreateUserAttributeDefinition
 * @property {string} [name]
 * @property {string} [slug]
 * @property {string} [description]
 * @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]
 * @property {number} [pin_order]
 * @property {string} [default_value]
 * @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]
 * @property {string[]} [user_id]
 * @property {string} [reason]
 */
/**
 * @typedef ArchiveUserRequestSchema
 * @property {string} [user_id]
 */
/**
 * @typedef UnDeleteUserRequestSchema
 * @property {string} [user_id]
 * @property {string} [reason]
 * @property {string} [reason_id]
 */
/**
 * @typedef BlockUserSuccess
 * @property {boolean} [success]
 */
/**
 * @typedef ArchiveUserSuccess
 * @property {boolean} [success]
 */
/**
 * @typedef UnDeleteUserSuccess
 * @property {boolean} [success]
 */
/**
 * @typedef UserSearchResponseSchema
 * @property {UserSearchSchema[]} [users]
 */
/**
 * @typedef CustomerListResponseSchema
 * @property {UserSearchSchema[]} [items]
 * @property {PaginationSchema} [page]
 */
/**
 * @typedef BulkActionPaginationSchema
 * @property {BulkActionModel[]} [items] - Array of Bulk Action Documents
 * @property {PaginationSchema} [page]
 */
/**
 * @typedef PaginationSchema
 * @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.
 */
/**
 * @typedef SessionListResponseSchema
 * @property {SessionListResponseInfo[]} [items]
 */
/**
 * @typedef SessionDeleteResponseSchema
 * @property {string} [user_id]
 * @property {string} [session_id]
 */
/**
 * @typedef SessionsDeleteResponseSchema
 * @property {string} [user_id]
 * @property {string[]} [session_ids]
 */
/**
 * @typedef APIError
 * @property {string} [code]
 * @property {string} [message]
 * @property {string} [info] - Error code description link
 * @property {string} [request_id]
 * @property {string} [error]
 * @property {Object} [meta]
 * @property {boolean} [authenticated]
 */
/**
 * @typedef SessionListResponseInfo
 * @property {string} [session_id]
 * @property {string} [user_agent]
 * @property {string} [ip]
 * @property {string} [domain]
 * @property {string} [expire_in]
 * @property {string} [location]
 */
/**
 * @typedef Conditions
 * @property {string} [user_attribute_definition_id]
 * @property {string} [type]
 * @property {string} [value]
 * @property {string} [key]
 */
/**
 * @typedef UserResponseErrorSchema
 * @property {number} [count]
 * @property {string} [file_url]
 */
/**
 * @typedef UserGroupResponseSchema
 * @property {Conditions[]} [conditions]
 * @property {UserResponseErrorSchema} [error]
 * @property {string} [name]
 * @property {string} [description]
 * @property {string} [file_url]
 * @property {string} [_id]
 * @property {string} [status]
 * @property {boolean} [is_active]
 * @property {string} [type]
 * @property {number} [uid]
 * @property {string} [application_id]
 * @property {string} [created_at]
 * @property {string} [modified_at]
 * @property {number} [__v]
 */
/**
 * @typedef UserGroupListResponseSchema
 * @property {UserGroupResponseSchema[]} [items]
 * @property {PaginationSchema} [page]
 */
/**
 * @typedef ConditionsSchema
 * @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.
 */
/**
 * @typedef CreateUserGroup
 * @property {ConditionsSchema[]} [conditions]
 * @property {string} [type]
 * @property {string} name
 * @property {string} description
 * @property {string} [file_url]
 */
/**
 * @typedef CreateUserRequestSchema
 * @property {string} [phone_number]
 * @property {string} [email]
 * @property {string} [first_name]
 * @property {string} [last_name]
 * @property {string} [gender]
 * @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").
 */
/**
 * @typedef CreateUserResponseSchema
 * @property {UserSchema} [user]
 */
/**
 * @typedef CreateUserSessionRequestSchema
 * @property {string} [domain]
 * @property {string} [user_id]
 */
/**
 * @typedef CreateUserSessionResponseSchema
 * @property {string} [domain]
 * @property {number} [max_age]
 * @property {boolean} [secure]
 * @property {boolean} [http_only]
 * @property {Object} [cookie]
 */
/**
 * @typedef PlatformSchema
 * @property {string} [display]
 * @property {LookAndFeel} [look_and_feel]
 * @property {string} [updated_at]
 * @property {boolean} [active]
 * @property {boolean} [forgot_password]
 * @property {Login} [login]
 * @property {boolean} [skip_captcha]
 * @property {string} [name]
 * @property {MetaSchema} [meta]
 * @property {string} [_id]
 * @property {Social} [social]
 * @property {RequiredFields} [required_fields]
 * @property {RegisterRequiredFields} [register_required_fields]
 * @property {boolean} [skip_login]
 * @property {FlashCard} [flash_card]
 * @property {string} [subtext]
 * @property {SocialTokens} [social_tokens]
 * @property {string} [created_at]
 * @property {boolean} [register]
 * @property {string} [mobile_image]
 * @property {string} [desktop_image]
 * @property {number} [delete_account_day]
 * @property {DeleteAccountReasons[]} [delete_account_reasons]
 * @property {DeleteAccountConsent} [delete_account_consent]
 * @property {SessionExpiry} [session_config]
 * @property {number} [__v]
 */
/**
 * @typedef LookAndFeel
 * @property {string} [card_position]
 * @property {string} [background_color]
 */
/**
 * @typedef Login
 * @property {boolean} [password]
 * @property {boolean} [otp]
 */
/**
 * @typedef MetaSchema
 * @property {boolean} [fynd_default]
 */
/**
 * @typedef Social
 * @property {boolean} [account_kit]
 * @property {boolean} [facebook]
 * @property {boolean} [google]
 * @property {boolean} [apple]
 */
/**
 * @typedef RequiredFields
 * @property {PlatformEmail} [email]
 * @property {PlatformMobile} [mobile]
 */
/**
 * @typedef PlatformEmail
 * @property {boolean} [is_required]
 * @property {string} [level]
 */
/**
 * @typedef PlatformMobile
 * @property {boolean} [is_required]
 * @property {string} [level]
 */
/**
 * @typedef RegisterRequiredFields
 * @property {RegisterRequiredFieldsEmail} [email]
 * @property {RegisterRequiredFieldsMobile} [mobile]
 */
/**
 * @typedef RegisterRequiredFieldsEmail
 * @property {boolean} [is_required]
 * @property {string} [level]
 */
/**
 * @typedef RegisterRequiredFieldsMobile
 * @property {boolean} [is_required]
 * @property {string} [level]
 */
/**
 * @typedef FlashCard
 * @property {string} [text]
 * @property {string} [text_color]
 * @property {string} [background_color]
 */
/**
 * @typedef SocialTokens
 * @property {Facebook} [facebook]
 * @property {Accountkit} [account_kit]
 * @property {Google} [google]
 * @property {Apple} [apple]
 */
/**
 * @typedef DeleteAccountReasons
 * @property {string} [reason_text]
 * @property {string} [reason_id]
 * @property {boolean} [show_text_area]
 */
/**
 * @typedef DeleteAccountConsent
 * @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]
 * @property {string} [app_secret]
 */
/**
 * @typedef Accountkit
 * @property {string} [app_id]
 * @property {string} [app_secret]
 */
/**
 * @typedef Google
 * @property {string} [app_id]
 * @property {string} [app_secret]
 */
/**
 * @typedef Apple
 * @property {string} [app_id]
 * @property {string} [redirect_uri]
 */
/**
 * @typedef SessionExpiry
 * @property {number} [duration]
 * @property {string} [type]
 * @property {boolean} [is_rolling]
 */
/**
 * @typedef UpdateUserGroupSchema
 * @property {ConditionsSchema[]} [conditions]
 * @property {string} [type]
 * @property {string} [name]
 * @property {string} [description]
 * @property {string} [file_url]
 */
/**
 * @typedef PartialUserGroupUpdateSchema
 * @property {string} [type] - Source of update to be used to update individual
 *   users. Default value is considered file_url if not passed.
 * @property {string} [name]
 * @property {string} [description]
 * @property {string} [file_url] - Required property when passed type file_url.
 *   Internet reachable csv file url which will be used to fetch download data.
 *   It must have one of columns from `phone_number``, `email`, `user_id` and
 *   must have `action` column. `action` column can have `add` or `remove` value.
 * @property {UserGroupUpdateData[]} [user_data] - Required property when passed
 *   type json. Array of user data. Must have `action` field and one of
 *   `phone_number`, `email` or `user_id` field in object
 */
/**
 * @typedef UserGroupUpdateData
 * @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
 */
/**
 * @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]
 * @property {Object} [meta]
 * @property {UserPhoneNumbers[]} [phone_numbers]
 * @property {UserEmails[]} [emails]
 */
/**
 * @typedef UserEmails
 * @property {boolean} [active]
 * @property {boolean} [primary]
 * @property {boolean} [verified]
 * @property {string} [email]
 */
/**
 * @typedef UserPhoneNumbers
 * @property {boolean} [active]
 * @property {boolean} [primary]
 * @property {boolean} [verified]
 * @property {string} [phone]
 * @property {string} [country_code]
 */
/**
 * @typedef UserSchema
 * @property {string} [application_id]
 * @property {string} [user_id]
 * @property {string} [first_name]
 * @property {Object} [meta]
 * @property {string} [last_name]
 * @property {PhoneNumber[]} [phone_numbers]
 * @property {Email[]} [emails]
 * @property {string} [gender]
 * @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]
 * @property {string} [account_type]
 * @property {string} [_id]
 * @property {string} [created_at]
 * @property {string} [updated_at]
 * @property {string} [external_id]
 * @property {string} [rr_id]
 * @property {UserConsent} [consent]
 */
/**
 * @typedef UserSearchSchema
 * @property {string} [application_id]
 * @property {string} [user_id]
 * @property {string} [first_name]
 * @property {Object} [meta]
 * @property {string} [last_name]
 * @property {PhoneNumber[]} [phone_numbers]
 * @property {Email[]} [emails]
 * @property {string} [gender]
 * @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]
 * @property {string} [account_type]
 * @property {string} [_id]
 * @property {string} [created_at]
 * @property {string} [updated_at]
 * @property {string} [external_id]
 * @property {string} [rr_id]
 * @property {boolean} [archive]
 * @property {string} [status]
 * @property {string} [deleted_on]
 * @property {UserConsent} [consent]
 */
/**
 * @typedef PhoneNumber
 * @property {string} [phone] - Phone number of the user.
 * @property {number} [country_code] - Country code for mobile number.
 * @property {boolean} [active] - Is the phone number active.
 * @property {boolean} [primary] - Is it a primary phone number.
 * @property {boolean} [verified] - Is the phone number verified.
 */
/**
 * @typedef Email
 * @property {string} [email] - Email address.
 * @property {boolean} [active] - Is the email active.
 * @property {boolean} [primary] - Is it a primary email.
 * @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
 */
declare class UserPlatformModel {
}
declare namespace UserPlatformModel {
    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, Apple, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email, UserConsent, DeleteUserGroupSuccess, PrivacyPolicyConsentSchema };
}
/** @returns {SuccessMessage} */
declare function SuccessMessage(): SuccessMessage;
type SuccessMessage = {
    success?: string;
};
/** @returns {UserAttributeDefinitionList} */
declare function UserAttributeDefinitionList(): UserAttributeDefinitionList;
type UserAttributeDefinitionList = {
    /**
     * - Array of user attribute
     * definition objects.
     */
    items?: UserAttributeDefinition[];
    page?: PaginationSchema;
};
/** @returns {UserAttributeDefinitionsResponseSchema} */
declare function UserAttributeDefinitionsResponseSchema(): UserAttributeDefinitionsResponseSchema;
type UserAttributeDefinitionsResponseSchema = {
    items?: UserAttribute[];
    page?: PaginationSchema;
};
/** @returns {UserAttributeDefinition} */
declare function UserAttributeDefinition(): UserAttributeDefinition;
type UserAttributeDefinition = {
    /**
     * - The unique identifier for the attribute definition.
     */
    _id?: string;
    /**
     * - The attribute name.
     */
    name?: string;
    /**
     * - The attribute key.
     */
    slug?: string;
    /**
     * - The description of the attribute.
     */
    description?: string;
    /**
     * - The application ID.
     */
    application_id?: string;
    /**
     * - The attribute type.
     */
    type?: string;
    /**
     * - Optional icon representation for this attribute.
     * Defaults to an empty string.
     */
    icon?: string;
    /**
     * - Ordering Channels where this
     * attribute should be visible.
     */
    ordering_channels?: string[];
    masking?: AttributeMaskingProperties;
    registration?: AttributeRegistrationProperties;
    /**
     * - Indicates if this attribute can accept
     * multiple values.
     */
    is_multi_value?: boolean;
    /**
     * - Whether the attribute is customer-editable.
     */
    customer_editable?: boolean;
    /**
     * - Whether the attribute is encrypted.
     */
    encrypted?: boolean;
    /**
     * - Whether the attribute is pinned.
     */
    pinned?: boolean;
    /**
     * - The order in which the attribute is pinned.
     */
    pin_order?: number;
    validations?: any[];
    /**
     * - Whether the attribute is locked.
     */
    is_locked?: boolean;
    /**
     * - The creation date of the attribute.
     */
    created_at?: string;
    /**
     * - The modification date of the attribute.
     */
    modified_at?: string;
    /**
     * - The version number of the attribute.
     */
    __v?: number;
    /**
     * - List of possible values for the attribute
     */
    options?: string[];
};
/** @returns {UserAttributeDefinitionDetails} */
declare function UserAttributeDefinitionDetails(): UserAttributeDefinitionDetails;
type UserAttributeDefinitionDetails = {
    /**
     * - The unique identifier for the attribute definition.
     */
    _id?: string;
    /**
     * - The attribute name.
     */
    name?: string;
    /**
     * - The attribute key.
     */
    slug?: string;
    /**
     * - The description of the attribute.
     */
    description?: string;
    /**
     * - The application ID.
     */
    application_id?: string;
    /**
     * - The attribute type.
     */
    type?: string;
    /**
     * - Optional icon representation for this attribute.
     * Defaults to an empty string.
     */
    icon?: string;
    /**
     * - Ordering Channels where this
     * attribute should be visible.
     */
    ordering_channels?: string[];
    masking?: AttributeMaskingProperties;
    registration?: AttributeRegistrationProperties;
    /**
     * - Indicates if this attribute can accept
     * multiple values.
     */
    is_multi_value?: boolean;
    /**
     * - Whether the attribute is customer-editable.
     */
    customer_editable?: boolean;
    /**
     * - Whether the attribute is encrypted.
     */
    encrypted?: boolean;
    /**
     * - Whether the attribute is pinned.
     */
    pinned?: boolean;
    /**
     * - The order in which the attribute is pinned.
     */
    pin_order?: number;
    validations?: UserAttributeDefinitionValidation[];
    /**
     * - Whether the attribute is locked.
     */
    is_locked?: boolean;
    /**
     * - The user who created the attribute.
     */
    created_by?: string;
    /**
     * - The user who last updated the attribute.
     */
    updated_by?: string;
    /**
     * - The creation date of the attribute definition.
     */
    created_at?: string;
    /**
     * - The last modification date of the
     * attribute definition.
     */
    modified_at?: string;
};
/** @returns {AttributeMaskingProperties} */
declare function AttributeMaskingProperties(): AttributeMaskingProperties;
type AttributeMaskingProperties = {
    /**
     * - Indicates if PII masking is editable for this
     * attribute.
     */
    enabled?: boolean;
    /**
     * - Indicates the PII masking options available
     * default or others
     */
    type?: string;
};
/** @returns {AttributeRegistrationProperties} */
declare function AttributeRegistrationProperties(): AttributeRegistrationProperties;
type AttributeRegistrationProperties = {
    /**
     * - Indicates if an attribute is editable when
     * customer registers for a storefront.
     */
    enabled?: boolean;
    /**
     * - Indicates if this attribute is mandatory or
     * optional when customer registers for a storefront.
     */
    type?: string;
};
/** @returns {UserAttributeDefinitionValidation} */
declare function UserAttributeDefinitionValidation(): UserAttributeDefinitionValidation;
type UserAttributeDefinitionValidation = {
    /**
     * - The type of validation.
     */
    type?: string;
    /**
     * - The validation value.
     */
    value?: any;
};
/** @returns {BulkUserAttribute} */
declare function BulkUserAttribute(): BulkUserAttribute;
type BulkUserAttribute = {
    /**
     * - This describes the status of the API response
     */
    success?: boolean;
    attributes?: UserAttribute[];
};
/** @returns {UserAttribute} */
declare function UserAttribute(): UserAttribute;
type UserAttribute = {
    /**
     * - The unique identifier for the attribute definition.
     */
    _id?: string;
    /**
     * - The name of user attribute definition.
     */
    name?: string;
    /**
     * - The unique identifier for the user.
     */
    user_id?: string;
    /**
     * - The application ID.
     */
    application_id?: string;
    /**
     * - The unique id of the
     * attribute definition.
     */
    user_attribute_definition_id?: string;
    /**
     * - The time when attribute value is created
     * for a user in ISO format.
     */
    created_at?: string;
    /**
     * - The time when attribute value is updated
     * for a user in ISO format.
     */
    updated_at?: string;
    /**
     * - The attribute type.
     */
    type?: string;
    /**
     * - Whether the attribute is customer-editable.
     */
    customer_overridden?: boolean;
    attribute?: any;
    updated_by?: string;
};
/** @returns {CreateBulkUserAttribute} */
declare function CreateBulkUserAttribute(): CreateBulkUserAttribute;
type CreateBulkUserAttribute = {
    /**
     * - This is an array of
     * objects containing id of attribute definitions and the respective values to
     * created or updated
     */
    attributes: BulkUserAttributeRequestBody[];
};
/** @returns {BulkUserAttributeRequestBody} */
declare function BulkUserAttributeRequestBody(): BulkUserAttributeRequestBody;
type BulkUserAttributeRequestBody = {
    /**
     * - Theis is an unique id of user attribute definition
     */
    definition_id: string;
    /**
     * - 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.
     */
    value: any;
};
/** @returns {CreateUserAttribute} */
declare function CreateUserAttribute(): CreateUserAttribute;
type CreateUserAttribute = {
    customer_overridden?: boolean;
    attribute?: any;
};
/** @returns {CreateUserAttributeDefinition} */
declare function CreateUserAttributeDefinition(): CreateUserAttributeDefinition;
type CreateUserAttributeDefinition = {
    name?: string;
    slug?: string;
    description?: string;
    /**
     * - The attribute type.
     */
    type?: string;
    /**
     * - Optional icon representation for this attribute.
     * Defaults to an empty string.
     */
    icon?: string;
    /**
     * - Ordering Channels where this
     * attribute should be visible.
     */
    ordering_channels?: string[];
    masking?: AttributeMaskingProperties;
    registration?: AttributeRegistrationProperties;
    /**
     * - Indicates if this attribute can accept
     * multiple values.
     */
    is_multi_value?: boolean;
    customer_editable?: boolean;
    encrypted?: boolean;
    pinned?: boolean;
    pin_order?: number;
    default_value?: string;
    validations?: any[];
};
/** @returns {CreateStoreFrontUsersPayload} */
declare function CreateStoreFrontUsersPayload(): CreateStoreFrontUsersPayload;
type CreateStoreFrontUsersPayload = {
    /**
     * - A valid URL linking to the file containing
     * user data to be imported.
     */
    absolute_url: string;
    /**
     * - The format of the file containing the user's
     * data. Supported formats are CSV and XLSX.
     */
    file_format: string;
    /**
     * - 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
     */
    relative_url: string;
};
/** @returns {BulkUserExportSchema} */
declare function BulkUserExportSchema(): BulkUserExportSchema;
type BulkUserExportSchema = {
    /**
     * - The format of the file in which you want to
     * export data. Supported formats are CSV and XLSX.
     */
    file_format: string;
};
/** @returns {BulkActionModel} */
declare function BulkActionModel(): BulkActionModel;
type BulkActionModel = {
    /**
     * - The Job ID associated with an Import or Export Job
     */
    _id: string;
    /**
     * - The name of the file
     */
    file_name: string;
    /**
     * - The format of the uploaded file (e.g., CSV, XLSX).
     */
    file_format: string;
    /**
     * - The type of bulk action being performed
     * (e.g., import, export).
     */
    action_type: string;
    created_by: CreatedBySchema;
    count?: BulkActionCountSchema;
    /**
     * - The current status of the bulk action.
     */
    status?: string;
    links?: BulkActionLinkSchema;
    /**
     * - The unique identifier of the associated
     * application.
     */
    application_id: string;
    /**
     * - The unique identifier of the company
     * associated with the bulk action.
     */
    company_id: string;
    /**
     * - The timestamp when the bulk action was created.
     */
    created_at?: string;
    /**
     * - The timestamp when the bulk action was last updated.
     */
    updated_at?: string;
};
/** @returns {CreatedBySchema} */
declare function CreatedBySchema(): CreatedBySchema;
type CreatedBySchema = {
    /**
     * - The name of the user who initiated the operation.
     */
    name: string;
    /**
     * - A unique identifier for the user who initiated
     * the operation.
     */
    user_id: string;
};
/** @returns {BulkActionLinkSchema} */
declare function BulkActionLinkSchema(): BulkActionLinkSchema;
type BulkActionLinkSchema = {
    file?: FileLinks;
    error?: FileLinks;
};
/** @returns {FileLinks} */
declare function FileLinks(): FileLinks;
type FileLinks = {
    /**
     * - The full URL of the file, including the
     * domain and protocol, allowing direct access to the file from any location.
     */
    absolute_url?: string;
    /**
     * - The relative path to the file within the
     * storage system, excluding the base URL or domain. This path is specific to
     * the storage structure.
     */
    relative_url?: string;
};
/** @returns {BulkActionCountSchema} */
declare function BulkActionCountSchema(): BulkActionCountSchema;
type BulkActionCountSchema = {
    /**
     * - The total number of items to be processed.
     */
    total?: number;
    /**
     * - The number of successfully processed items.
     */
    success?: number;
    /**
     * - The number of items that failed to process.
     */
    error?: number;
};
/** @returns {BlockUserRequestSchema} */
declare function BlockUserRequestSchema(): BlockUserRequestSchema;
type BlockUserRequestSchema = {
    status?: boolean;
    user_id?: string[];
    reason?: string;
};
/** @returns {ArchiveUserRequestSchema} */
declare function ArchiveUserRequestSchema(): ArchiveUserRequestSchema;
type ArchiveUserRequestSchema = {
    user_id?: string;
};
/** @returns {UnDeleteUserRequestSchema} */
declare function UnDeleteUserRequestSchema(): UnDeleteUserRequestSchema;
type UnDeleteUserRequestSchema = {
    user_id?: string;
    reason?: string;
    reason_id?: string;
};
/** @returns {BlockUserSuccess} */
declare function BlockUserSuccess(): BlockUserSuccess;
type BlockUserSuccess = {
    success?: boolean;
};
/** @returns {ArchiveUserSuccess} */
declare function ArchiveUserSuccess(): ArchiveUserSuccess;
type ArchiveUserSuccess = {
    success?: boolean;
};
/** @returns {UnDeleteUserSuccess} */
declare function UnDeleteUserSuccess(): UnDeleteUserSuccess;
type UnDeleteUserSuccess = {
    success?: boolean;
};
/** @returns {UserSearchResponseSchema} */
declare function UserSearchResponseSchema(): UserSearchResponseSchema;
type UserSearchResponseSchema = {
    users?: UserSearchSchema[];
};
/** @returns {CustomerListResponseSchema} */
declare function CustomerListResponseSchema(): CustomerListResponseSchema;
type CustomerListResponseSchema = {
    items?: UserSearchSchema[];
    page?: PaginationSchema;
};
/** @returns {BulkActionPaginationSchema} */
declare function BulkActionPaginationSchema(): BulkActionPaginationSchema;
type BulkActionPaginationSchema = {
    /**
     * - Array of Bulk Action Documents
     */
    items?: BulkActionModel[];
    page?: PaginationSchema;
};
/** @returns {PaginationSchema} */
declare function PaginationSchema(): PaginationSchema;
type PaginationSchema = {
    /**
     * - The number of items per page.
     */
    size?: number;
    /**
     * - The total number of items across all pages.
     */
    total?: number;
    /**
     * - The total number of items across all pages.
     */
    item_total?: number;
    /**
     * - Indicates whether there are more pages to retrieve.
     */
    has_next?: boolean;
    /**
     * - The type of pagination used (eg Number).
     */
    type?: string;
    /**
     * - The current page number.
     */
    current?: number;
};
/** @returns {SessionListResponseSchema} */
declare function SessionListResponseSchema(): SessionListResponseSchema;
type SessionListResponseSchema = {
    items?: SessionListResponseInfo[];
};
/** @returns {SessionDeleteResponseSchema} */
declare function SessionDeleteResponseSchema(): SessionDeleteResponseSchema;
type SessionDeleteResponseSchema = {
    user_id?: string;
    session_id?: string;
};
/** @returns {SessionsDeleteResponseSchema} */
declare function SessionsDeleteResponseSchema(): SessionsDeleteResponseSchema;
type SessionsDeleteResponseSchema = {
    user_id?: string;
    session_ids?: string[];
};
/** @returns {APIError} */
declare function APIError(): APIError;
type APIError = {
    code?: string;
    message?: string;
    /**
     * - Error code description link
     */
    info?: string;
    request_id?: string;
    error?: string;
    meta?: any;
    authenticated?: boolean;
};
/** @returns {SessionListResponseInfo} */
declare function SessionListResponseInfo(): SessionListResponseInfo;
type SessionListResponseInfo = {
    session_id?: string;
    user_agent?: string;
    ip?: string;
    domain?: string;
    expire_in?: string;
    location?: string;
};
/** @returns {Conditions} */
declare function Conditions(): Conditions;
type Conditions = {
    user_attribute_definition_id?: string;
    type?: string;
    value?: string;
    key?: string;
};
/** @returns {UserResponseErrorSchema} */
declare function UserResponseErrorSchema(): UserResponseErrorSchema;
type UserResponseErrorSchema = {
    count?: number;
    file_url?: string;
};
/** @returns {UserGroupResponseSchema} */
declare function UserGroupResponseSchema(): UserGroupResponseSchema;
type UserGroupResponseSchema = {
    conditions?: Conditions[];
    error?: UserResponseErrorSchema;
    name?: string;
    description?: string;
    file_url?: string;
    _id?: string;
    status?: string;
    is_active?: boolean;
    type?: string;
    uid?: number;
    application_id?: string;
    created_at?: string;
    modified_at?: string;
    __v?: number;
};
/** @returns {UserGroupListResponseSchema} */
declare function UserGroupListResponseSchema(): UserGroupListResponseSchema;
type UserGroupListResponseSchema = {
    items?: UserGroupResponseSchema[];
    page?: PaginationSchema;
};
/** @returns {ConditionsSchema} */
declare function ConditionsSchema(): ConditionsSchema;
type ConditionsSchema = {
    /**
     * - ID of the user attribute
     * definition used in the condition
     */
    user_attribute_definition_id?: string;
    /**
     * - Type of condition to apply on the attribute value.
     */
    type?: string;
    /**
     * - Value of the condition
     */
    value?: any;
    /**
     * - Indicates if the year should be ignored
     * for the condition
     */
    ignore_year?: boolean;
};
/** @returns {DeleteBulkUserAttribute} */
declare function DeleteBulkUserAttribute(): DeleteBulkUserAttribute;
type DeleteBulkUserAttribute = {
    /**
     * - List of user attribute definition IDs
     * for which the corresponding values should be deleted.
     */
    definition_ids?: string[];
};
/** @returns {UserAttributeFilter} */
declare function UserAttributeFilter(): UserAttributeFilter;
type UserAttributeFilter = {
    query?: UserAttributeFilterQuery;
};
/** @returns {UserAttributeFilterQuery} */
declare function UserAttributeFilterQuery(): UserAttributeFilterQuery;
type UserAttributeFilterQuery = {
    /**
     * - Logical condition type to apply between multiple
     * attribute filters.
     */
    type: string;
    /**
     * - Number of results to return per page.
     */
    limit: number;
    /**
     * - Page number to fetch.
     */
    page: number;
    /**
     * - Filter users by their exact email address.
     */
    email?: string;
    /**
     * - Apply a filter to retrieve users who have a
     * valid email address specified in their profile.
     */
    has_email?: boolean;
    /**
     * - Apply a filter to retrieve users who have a
     * valid phone number specified in their profile.
     */
    has_phone?: boolean;
    /**
     * - Filter users by their exact phone number.
     */
    phone?: string;
    /**
     * - List of user attribute definition IDs
     * to fetch attributes values available for each user.
     */
    definition_ids?: string[];
    /**
     * - List of
     * filtering conditions to apply on user attributes.
     */
    conditions: UserAttributeFilterRequestConditions[];
};
/** @returns {UserAttributeFilterRequestConditions} */
declare function UserAttributeFilterRequestConditions(): UserAttributeFilterRequestConditions;
type UserAttributeFilterRequestConditions = {
    /**
     * - ID of the user attribute definition to filter on.
     */
    definition_id: string;
    /**
     * - 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
     */
    type: string;
    /**
     * - 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.
     */
    value: any;
};
/** @returns {UserAttributeFiltered} */
declare function UserAttributeFiltered(): UserAttributeFiltered;
type UserAttributeFiltered = {
    /**
     * - List of user objects that
     * match the filter criteria.
     */
    items?: UserAttributeFilteredList[];
    page?: PaginationSchema;
};
/** @returns {UserAttributeFilteredList} */
declare function UserAttributeFilteredList(): UserAttributeFilteredList;
type UserAttributeFilteredList = {
    /**
     * - Unique ID of the user.
     */
    _id?: string;
    /**
     * - Generated username for the user.
     */
    username?: string;
    /**
     * - List of phone numbers
     * associated with the user.
     */
    phone_numbers?: UserPhoneNumbers[];
    /**
     * - List of emails associated with the user.
     */
    emails?: UserEmails[];
    /**
     * - Gender of the user.
     */
    gender?: string;
    /**
     * - Whether the user account is active.
     */
    active?: boolean;
    /**
     * - Whether the user account is archived.
     */
    archive?: boolean;
    /**
     * - Status of the user account.
     */
    status?: string;
    attributes?: UserAttribute[];
    /**
     * - First name of the user.
     */
    first_name?: string;
    /**
     * - Last name of the user.
     */
    last_name?: string;
    /**
     * - Type of user account.
     */
    account_type?: string;
    /**
     * - URL to user's profile picture.
     */
    profile_pic_url?: string;
    /**
     * - Whether user has legacy password format.
     */
    has_old_password_hash?: boolean;
    /**
     * - Unique user ID.
     */
    user_id?: string;
    /**
     * - Application ID associated with the user.
     */
    application_id?: string;
    /**
     * - Whether the user data is encrypted.
     */
    is_encrypted?: boolean;
    /**
     * - Timestamp of user creation.
     */
    created_at?: string;
    /**
     * - Timestamp of last update.
     */
    updated_at?: string;
};
/** @returns {CreateUserGroup} */
declare function CreateUserGroup(): CreateUserGroup;
type CreateUserGroup = {
    conditions?: ConditionsSchema[];
    type?: string;
    name: string;
    description: string;
    file_url?: string;
};
/** @returns {CreateUserRequestSchema} */
declare function CreateUserRequestSchema(): CreateUserRequestSchema;
type CreateUserRequestSchema = {
    phone_number?: string;
    email?: string;
    first_name?: string;
    last_name?: string;
    gender?: string;
    username?: string;
    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;
type CreateUserResponseSchema = {
    user?: UserSchema;
};
/** @returns {CreateUserSessionRequestSchema} */
declare function CreateUserSessionRequestSchema(): CreateUserSessionRequestSchema;
type CreateUserSessionRequestSchema = {
    domain?: string;
    user_id?: string;
};
/** @returns {CreateUserSessionResponseSchema} */
declare function CreateUserSessionResponseSchema(): CreateUserSessionResponseSchema;
type CreateUserSessionResponseSchema = {
    domain?: string;
    max_age?: number;
    secure?: boolean;
    http_only?: boolean;
    cookie?: any;
};
/** @returns {PlatformSchema} */
declare function PlatformSchema(): PlatformSchema;
type PlatformSchema = {
    display?: string;
    look_and_feel?: LookAndFeel;
    updated_at?: string;
    active?: boolean;
    forgot_password?: boolean;
    login?: Login;
    skip_captcha?: boolean;
    name?: string;
    meta?: MetaSchema;
    _id?: string;
    social?: Social;
    required_fields?: RequiredFields;
    register_required_fields?: RegisterRequiredFields;
    skip_login?: boolean;
    flash_card?: FlashCard;
    subtext?: string;
    social_tokens?: SocialTokens;
    created_at?: string;
    register?: boolean;
    mobile_image?: string;
    desktop_image?: string;
    delete_account_day?: number;
    delete_account_reasons?: DeleteAccountReasons[];
    delete_account_consent?: DeleteAccountConsent;
    session_config?: SessionExpiry;
    __v?: number;
};
/** @returns {LookAndFeel} */
declare function LookAndFeel(): LookAndFeel;
type LookAndFeel = {
    card_position?: string;
    background_color?: string;
};
/** @returns {Login} */
declare function Login(): Login;
type Login = {
    password?: boolean;
    otp?: boolean;
};
/** @returns {MetaSchema} */
declare function MetaSchema(): MetaSchema;
type MetaSchema = {
    fynd_default?: boolean;
};
/** @returns {Social} */
declare function Social(): Social;
type Social = {
    account_kit?: boolean;
    facebook?: boolean;
    google?: boolean;
    apple?: boolean;
};
/** @returns {RequiredFields} */
declare function RequiredFields(): RequiredFields;
type RequiredFields = {
    email?: PlatformEmail;
    mobile?: PlatformMobile;
};
/** @returns {PlatformEmail} */
declare function PlatformEmail(): PlatformEmail;
type PlatformEmail = {
    is_required?: boolean;
    level?: string;
};
/** @returns {PlatformMobile} */
declare function PlatformMobile(): PlatformMobile;
type PlatformMobile = {
    is_required?: boolean;
    level?: string;
};
/** @returns {RegisterRequiredFields} */
declare function RegisterRequiredFields(): RegisterRequiredFields;
type RegisterRequiredFields = {
    email?: RegisterRequiredFieldsEmail;
    mobile?: RegisterRequiredFieldsMobile;
};
/** @returns {RegisterRequiredFieldsEmail} */
declare function RegisterRequiredFieldsEmail(): RegisterRequiredFieldsEmail;
type RegisterRequiredFieldsEmail = {
    is_required?: boolean;
    level?: string;
};
/** @returns {RegisterRequiredFieldsMobile} */
declare function RegisterRequiredFieldsMobile(): RegisterRequiredFieldsMobile;
type RegisterRequiredFieldsMobile = {
    is_required?: boolean;
    level?: string;
};
/** @returns {FlashCard} */
declare function FlashCard(): FlashCard;
type FlashCard = {
    text?: string;
    text_color?: string;
    background_color?: string;
};
/** @returns {SocialTokens} */
declare function SocialTokens(): SocialTokens;
type SocialTokens = {
    facebook?: Facebook;
    account_kit?: Accountkit;
    google?: Google;
    apple?: Apple;
};
/** @returns {DeleteAccountReasons} */
declare function DeleteAccountReasons(): DeleteAccountReasons;
type DeleteAccountReasons = {
    reason_text?: string;
    reason_id?: string;
    show_text_area?: boolean;
};
/** @returns {DeleteAccountConsent} */
declare function DeleteAccountConsent(): DeleteAccountConsent;
type DeleteAccountConsent = {
    consent_text?: string;
};
/** @returns {GetUserTimeline} */
declare function GetUserTimeline(): GetUserTimeline;
type GetUserTimeline = {
    /**
     * - Denotes the date on which the user will be deleted
     */
    delete_on?: string;
    /**
     * - List of user timeline events
     */
    timeline?: UserTimeline[];
};
/** @returns {UserTimeline} */
declare function UserTimeline(): UserTimeline;
type UserTimeline = {
    /**
     * - Denotes the date at which this event occured
     */
    date?: string;
    /**
     * - Title of the timeline event
     */
    title?: string;
    /**
     * - Type of the event, indicating its status
     */
    type?: string;
    /**
     * - Indicates whether the event should be shown on the UI
     */
    visible?: boolean;
    /**
     * - Additional information about the event
     */
    sub_title?: string;
};
/** @returns {Facebook} */
declare function Facebook(): Facebook;
type Facebook = {
    app_id?: string;
    app_secret?: string;
};
/** @returns {Accountkit} */
declare function Accountkit(): Accountkit;
type Accountkit = {
    app_id?: string;
    app_secret?: string;
};
/** @returns {Google} */
declare function Google(): Google;
type Google = {
    app_id?: string;
    app_secret?: string;
};
/** @returns {Apple} */
declare function Apple(): Apple;
type Apple = {
    app_id?: string;
    redirect_uri?: string;
};
/** @returns {SessionExpiry} */
declare function SessionExpiry(): SessionExpiry;
type SessionExpiry = {
    duration?: number;
    type?: string;
    is_rolling?: boolean;
};
/** @returns {UpdateUserGroupSchema} */
declare function UpdateUserGroupSchema(): UpdateUserGroupSchema;
type UpdateUserGroupSchema = {
    conditions?: ConditionsSchema[];
    type?: string;
    name?: string;
    description?: string;
    file_url?: string;
};
/** @returns {PartialUserGroupUpdateSchema} */
declare function PartialUserGroupUpdateSchema(): PartialUserGroupUpdateSchema;
type PartialUserGroupUpdateSchema = {
    /**
     * - Source of update to be used to update individual
     * users. Default value is considered file_url if not passed.
     */
    type?: string;
    name?: string;
    description?: string;
    /**
     * - Required property when passed type file_url.
     * Internet reachable csv file url which will be used to fetch download data.
     * It must have one of columns from `phone_number``, `email`, `user_id` and
     * must have `action` column. `action` column can have `add` or `remove` value.
     */
    file_url?: string;
    /**
     * - Required property when passed
     * type json. Array of user data. Must have `action` field and one of
     * `phone_number`, `email` or `user_id` field in object
     */
    user_data?: UserGroupUpdateData[];
};
/** @returns {UserGroupUpdateData} */
declare function UserGroupUpdateData(): UserGroupUpdateData;
type UserGroupUpdateData = {
    /**
     * - Must be valid ID of existing user
     */
    user_id?: string;
    /**
     * - Phone number of registered user
     */
    phone_number?: string;
    /**
     * - Email of registered user
     */
    email?: string;
    action: string;
};
/** @returns {UpdateUserRequestSchema} */
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;
    meta?: any;
    phone_numbers?: UserPhoneNumbers[];
    emails?: UserEmails[];
};
/** @returns {UserEmails} */
declare function UserEmails(): UserEmails;
type UserEmails = {
    active?: boolean;
    primary?: boolean;
    verified?: boolean;
    email?: string;
};
/** @returns {UserPhoneNumbers} */
declare function UserPhoneNumbers(): UserPhoneNumbers;
type UserPhoneNumbers = {
    active?: boolean;
    primary?: boolean;
    verified?: boolean;
    phone?: string;
    country_code?: string;
};
/** @returns {UserSchema} */
declare function UserSchema(): UserSchema;
type UserSchema = {
    application_id?: string;
    user_id?: string;
    first_name?: string;
    meta?: any;
    last_name?: string;
    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;
    username?: string;
    account_type?: string;
    _id?: string;
    created_at?: string;
    updated_at?: string;
    external_id?: string;
    rr_id?: string;
    consent?: UserConsent;
};
/** @returns {UserSearchSchema} */
declare function UserSearchSchema(): UserSearchSchema;
type UserSearchSchema = {
    application_id?: string;
    user_id?: string;
    first_name?: string;
    meta?: any;
    last_name?: string;
    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;
    username?: string;
    account_type?: string;
    _id?: string;
    created_at?: string;
    updated_at?: string;
    external_id?: string;
    rr_id?: string;
    archive?: boolean;
    status?: string;
    deleted_on?: string;
    consent?: UserConsent;
};
/** @returns {PhoneNumber} */
declare function PhoneNumber(): PhoneNumber;
type PhoneNumber = {
    /**
     * - Phone number of the user.
     */
    phone?: string;
    /**
     * - Country code for mobile number.
     */
    country_code?: number;
    /**
     * - Is the phone number active.
     */
    active?: boolean;
    /**
     * - Is it a primary phone number.
     */
    primary?: boolean;
    /**
     * - Is the phone number verified.
     */
    verified?: boolean;
};
/** @returns {Email} */
declare function Email(): Email;
type Email = {
    /**
     * - Email address.
     */
    email?: string;
    /**
     * - Is the email active.
     */
    active?: boolean;
    /**
     * - Is it a primary email.
     */
    primary?: boolean;
    /**
     * - Is the email verified.
     */
    verified?: boolean;
};
/** @returns {UserConsent} */
declare function UserConsent(): UserConsent;
type UserConsent = {
    privacy_policy?: PrivacyPolicyConsentSchema;
};
/** @returns {DeleteUserGroupSuccess} */
declare function DeleteUserGroupSuccess(): DeleteUserGroupSuccess;
type DeleteUserGroupSuccess = {
    /**
     * - ID of the user group that was deleted
     */
    id: string;
    /**
     * - Success indicating the user group was deleted
     * successfully.
     */
    success: boolean;
};
/** @returns {PrivacyPolicyConsentSchema} */
declare function PrivacyPolicyConsentSchema(): PrivacyPolicyConsentSchema;
type PrivacyPolicyConsentSchema = {
    /**
     * - Whether the user has consented to the privacy policy
     */
    value?: boolean;
    /**
     * - When the consent was last updated
     */
    updated_at?: string;
};