@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.4

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

@@ -1,80 +1,219 @@
 export = UserPlatformModel;
 /**
- * @typedef Accountkit
- * @property {string} [app_id]
+ * @typedef SuccessMessageResponse
+ * @property {string} [success]
  */
 /**
- * @typedef ArchiveUserRequestSchema
- * @property {string} [user_id]
+ * @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 {boolean} [multi_value] - Whether the attribute supports 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.
  */
 /**
- * @typedef ArchiveUserSuccess
- * @property {boolean} [success]
+ * @typedef UserAttributeDefinitionResponse
+ * @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 {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 AuthenticationApiErrorSchema
- * @property {string} [message]
+ * @typedef UserAttributeDefinitionValidation
+ * @property {string} [type] - The type of validation.
+ * @property {Object} [value] - The validation value.
+ */
+/**
+ * @typedef UserAttributeResponse
+ * @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} [type] - The attribute type.
+ * @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
+ * @property {Object} [attribute]
+ * @property {string} [updated_by]
+ */
+/**
+ * @typedef CreateUserAttributeRequest
+ * @property {boolean} [customer_overriden]
+ * @property {Object} [attribute]
+ */
+/**
+ * @typedef CreateUserAttributeDefinition
+ * @property {string} [name]
+ * @property {string} [slug]
+ * @property {string} [description]
+ * @property {string} [type]
+ * @property {boolean} [multi_value]
+ * @property {boolean} [customer_editable]
+ * @property {boolean} [encrypted]
+ * @property {boolean} [pinned]
+ * @property {number} [pin_order]
+ * @property {string} [default_value]
+ * @property {Object[]} [validations]
  */
 /**
  * @typedef BlockUserRequestSchema
- * @property {string} [reason]
  * @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 Conditions
- * @property {string} [key]
- * @property {string} [type]
- * @property {string} [user_attribute_definition_id]
- * @property {string} [value]
+ * @typedef ArchiveUserSuccess
+ * @property {boolean} [success]
  */
 /**
- * @typedef ConditionsSchema
+ * @typedef UnDeleteUserSuccess
+ * @property {boolean} [success]
+ */
+/**
+ * @typedef UserSearchResponseSchema
+ * @property {UserSearchSchema[]} [users]
+ */
+/**
+ * @typedef CustomerListResponseSchema
+ * @property {UserSchema[]} [items]
+ * @property {PaginationSchema} [page]
+ */
+/**
+ * @typedef PaginationSchema
+ * @property {number} [size]
+ * @property {number} [item_total]
+ * @property {boolean} [has_next]
  * @property {string} [type]
+ * @property {number} [current]
+ */
+/**
+ * @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 CreateUserAttributeDefinition
- * @property {boolean} [customer_editable]
- * @property {string} [default_value]
- * @property {string} [description]
- * @property {boolean} [encrypted]
- * @property {boolean} [multi_value]
+ * @typedef UserResponseErrorSchema
+ * @property {number} [count]
+ * @property {string} [file_url]
+ */
+/**
+ * @typedef UserGroupResponseSchema
+ * @property {Conditions[]} [conditions]
+ * @property {UserResponseErrorSchema} [error]
  * @property {string} [name]
- * @property {number} [pin_order]
- * @property {boolean} [pinned]
- * @property {string} [slug]
+ * @property {string} [description]
+ * @property {string} [file_url]
+ * @property {string} [_id]
+ * @property {string} [status]
+ * @property {boolean} [is_active]
  * @property {string} [type]
- * @property {Object[]} [validations]
+ * @property {number} [uid]
+ * @property {string} [application_id]
+ * @property {string} [created_at]
+ * @property {string} [modified_at]
+ * @property {number} [__v]
  */
 /**
- * @typedef CreateUserAttributeRequest
- * @property {Object} [attribute]
- * @property {boolean} [customer_overriden]
+ * @typedef UserGroupListResponseSchema
+ * @property {UserGroupResponseSchema[]} [items]
+ * @property {PaginationSchema} [page]
+ */
+/**
+ * @typedef ConditionsSchema
+ * @property {string} [user_attribute_definition_id]
+ * @property {string} [type]
+ * @property {string} [value]
  */
 /**
  * @typedef CreateUserGroup
  * @property {ConditionsSchema[]} [conditions]
+ * @property {string} [type]
+ * @property {string} name
  * @property {string} description
  * @property {string} [file_url]
- * @property {string} name
- * @property {string} [type]
  */
 /**
  * @typedef CreateUserRequestSchema
+ * @property {string} phone_number
  * @property {string} [email]
- * @property {string} [external_id]
  * @property {string} [first_name]
- * @property {string} [gender]
  * @property {string} [last_name]
- * @property {Object} [meta]
- * @property {string} phone_number
+ * @property {string} [gender]
  * @property {string} username
+ * @property {Object} [meta]
+ * @property {string} [external_id]
  */
 /**
  * @typedef CreateUserResponseSchema
@@ -88,91 +227,66 @@ export = UserPlatformModel;
  */
 /**
  * @typedef CreateUserSessionResponseSchema
- * @property {Object} [cookie]
  * @property {string} [domain]
- * @property {boolean} [http_only]
  * @property {number} [max_age]
  * @property {boolean} [secure]
+ * @property {boolean} [http_only]
+ * @property {Object} [cookie]
  */
 /**
- * @typedef CustomerListResponseSchema
- * @property {UserSchema[]} [items]
- * @property {PaginationSchema} [page]
+ * @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 DeleteAccountConsent
- * @property {string} [consent_text]
+ * @typedef LookAndFeel
+ * @property {string} [card_position]
+ * @property {string} [background_color]
  */
 /**
- * @typedef DeleteAccountReasons
- * @property {string} [reason_id]
- * @property {string} [reason_text]
- * @property {boolean} [show_text_area]
+ * @typedef Login
+ * @property {boolean} [password]
+ * @property {boolean} [otp]
  */
 /**
- * @typedef Email
- * @property {boolean} [active]
- * @property {string} [email]
- * @property {boolean} [primary]
- * @property {boolean} [verified]
+ * @typedef MetaSchema
+ * @property {boolean} [fynd_default]
  */
 /**
- * @typedef Facebook
- * @property {string} [app_id]
+ * @typedef Social
+ * @property {boolean} [account_kit]
+ * @property {boolean} [facebook]
+ * @property {boolean} [google]
+ * @property {boolean} [apple]
  */
 /**
- * @typedef FlashCard
- * @property {string} [background_color]
- * @property {string} [text]
- * @property {string} [text_color]
- */
-/**
- * @typedef Google
- * @property {string} [app_id]
- */
-/**
- * @typedef Login
- * @property {boolean} [otp]
- * @property {boolean} [password]
- */
-/**
- * @typedef LookAndFeel
- * @property {string} [background_color]
- * @property {string} [card_position]
- */
-/**
- * @typedef MetaSchema
- * @property {boolean} [fynd_default]
- */
-/**
- * @typedef PaginationSchema
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {number} [item_total]
- * @property {number} [size]
- * @property {string} [type]
- */
-/**
- * @typedef PartialUserGroupUpdateSchema
- * @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 {string} [name]
- * @property {string} [type] - Source of update to be used to update individual
- *   users. Default value is considered file_url if not passed.
- * @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 PhoneNumber
- * @property {boolean} [active]
- * @property {number} [country_code]
- * @property {string} [phone]
- * @property {boolean} [primary]
- * @property {boolean} [verified]
+ * @typedef RequiredFields
+ * @property {PlatformEmail} [email]
+ * @property {PlatformMobile} [mobile]
  */
 /**
  * @typedef PlatformEmail
@@ -184,34 +298,6 @@ export = UserPlatformModel;
  * @property {boolean} [is_required]
  * @property {string} [level]
  */
-/**
- * @typedef PlatformSchema
- * @property {string} [_id]
- * @property {boolean} [active]
- * @property {string} [created_at]
- * @property {Object} [delete_account_consent]
- * @property {number} [delete_account_day]
- * @property {DeleteAccountReasons[]} [delete_account_reasons]
- * @property {string} [desktop_image]
- * @property {string} [display]
- * @property {FlashCard} [flash_card]
- * @property {boolean} [forgot_password]
- * @property {Login} [login]
- * @property {LookAndFeel} [look_and_feel]
- * @property {MetaSchema} [meta]
- * @property {string} [mobile_image]
- * @property {string} [name]
- * @property {boolean} [register]
- * @property {RegisterRequiredFields} [register_required_fields]
- * @property {RequiredFields} [required_fields]
- * @property {Object} [session_config]
- * @property {boolean} [skip_captcha]
- * @property {boolean} [skip_login]
- * @property {Social} [social]
- * @property {SocialTokens} [social_tokens]
- * @property {string} [subtext]
- * @property {string} [updated_at]
- */
 /**
  * @typedef RegisterRequiredFields
  * @property {RegisterRequiredFieldsEmail} [email]
@@ -228,305 +314,527 @@ export = UserPlatformModel;
  * @property {string} [level]
  */
 /**
- * @typedef RequiredFields
- * @property {PlatformEmail} [email]
- * @property {PlatformMobile} [mobile]
- */
-/**
- * @typedef SessionDeleteResponseSchema
- * @property {string} [session_id]
- * @property {string} [user_id]
- */
-/**
- * @typedef SessionExpiry
- * @property {number} [duration]
- * @property {boolean} [is_rolling]
- * @property {string} [type]
- */
-/**
- * @typedef SessionListResponseInfo
- * @property {string} [domain]
- * @property {string} [expire_in]
- * @property {string} [ip]
- * @property {string} [session_id]
- * @property {string} [user_agent]
+ * @typedef FlashCard
+ * @property {string} [text]
+ * @property {string} [text_color]
+ * @property {string} [background_color]
  */
 /**
- * @typedef SessionListResponseSchema
- * @property {SessionListResponseInfo[]} [items]
+ * @typedef SocialTokens
+ * @property {Facebook} [facebook]
+ * @property {Accountkit} [accountkit]
+ * @property {Google} [google]
  */
 /**
- * @typedef SessionsDeleteResponseSchema
- * @property {string[]} [session_ids]
- * @property {string} [user_id]
+ * @typedef DeleteAccountReasons
+ * @property {string} [reason_text]
+ * @property {string} [reason_id]
+ * @property {boolean} [show_text_area]
  */
 /**
- * @typedef Social
- * @property {boolean} [account_kit]
- * @property {boolean} [apple]
- * @property {boolean} [facebook]
- * @property {boolean} [google]
+ * @typedef DeleteAccountConsent
+ * @property {string} [consent_text]
  */
 /**
- * @typedef SocialTokens
- * @property {Accountkit} [account_kit]
- * @property {Facebook} [facebook]
- * @property {Google} [google]
+ * @typedef Facebook
+ * @property {string} [app_id]
+ * @property {string} [app_secret]
  */
 /**
- * @typedef SuccessMessageResponse
- * @property {string} [success]
+ * @typedef Accountkit
+ * @property {string} [app_id]
+ * @property {string} [app_secret]
  */
 /**
- * @typedef UnDeleteUserRequestSchema
- * @property {string} [reason]
- * @property {string} [reason_id]
- * @property {string} [user_id]
+ * @typedef Google
+ * @property {string} [app_id]
+ * @property {string} [app_secret]
  */
 /**
- * @typedef UnDeleteUserSuccess
- * @property {boolean} [success]
+ * @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} [type]
+ * @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 mongodb objectid 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 {UserEmails[]} [emails]
- * @property {string} [external_id]
  * @property {string} [first_name]
- * @property {string} [gender]
  * @property {string} [last_name]
+ * @property {string} [gender]
+ * @property {string} [external_id]
  * @property {Object} [meta]
  * @property {UserPhoneNumbers[]} [phone_numbers]
- */
-/**
- * @typedef UserAttributeDefinition
- * @property {number} [__v] - The version number of the attribute.
- * @property {string} [_id] - The unique identifier for the attribute definition.
- * @property {string} [application_id] - The application ID.
- * @property {string} [created_at] - The creation date of the attribute.
- * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
- * @property {string} [description] - The description of the attribute.
- * @property {boolean} [encrypted] - Whether the attribute is encrypted.
- * @property {boolean} [is_locked] - Whether the attribute is locked.
- * @property {string} [modified_at] - The modification date of the attribute.
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
- * @property {string} [name] - The attribute name.
- * @property {number} [pin_order] - The order in which the attribute is pinned.
- * @property {boolean} [pinned] - Whether the attribute is pinned.
- * @property {string} [slug] - The attribute key.
- * @property {string} [type] - The attribute type.
- * @property {Object[]} [validations]
- */
-/**
- * @typedef UserAttributeDefinitionResponse
- * @property {string} [_id] - The unique identifier for the attribute definition.
- * @property {string} [application_id] - The application ID.
- * @property {string} [created_at] - The creation date of the attribute definition.
- * @property {string} [created_by] - The user who created the attribute.
- * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
- * @property {string} [description] - The description of the attribute.
- * @property {boolean} [encrypted] - Whether the attribute is encrypted.
- * @property {boolean} [is_locked] - Whether the attribute is locked.
- * @property {string} [modified_at] - The last modification date of the
- *   attribute definition.
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
- * @property {string} [name] - The attribute name.
- * @property {number} [pin_order] - The order in which the attribute is pinned.
- * @property {boolean} [pinned] - Whether the attribute is pinned.
- * @property {string} [slug] - The attribute key.
- * @property {string} [type] - The attribute type.
- * @property {string} [updated_by] - The user who last updated the attribute.
- * @property {UserAttributeDefinitionValidation[]} [validations]
- */
-/**
- * @typedef UserAttributeDefinitionValidation
- * @property {string} [type] - The type of validation.
- * @property {Object} [value] - The validation value.
- */
-/**
- * @typedef UserAttributeResponse
- * @property {string} [_id] - The unique identifier for the attribute definition.
- * @property {string} [application_id] - The application ID.
- * @property {Object} [attribute]
- * @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
- * @property {string} [name] - The name of user attribute definition.
- * @property {string} [type] - The attribute type.
- * @property {string} [updated_by]
- * @property {string} [user_id] - The unique identifier for the user.
+ * @property {UserEmails[]} [emails]
  */
 /**
  * @typedef UserEmails
  * @property {boolean} [active]
- * @property {string} [email]
  * @property {boolean} [primary]
  * @property {boolean} [verified]
+ * @property {string} [email]
  */
 /**
- * @typedef UserGroupListResponseSchema
- * @property {UserGroupResponseSchema[]} [items]
- * @property {PaginationSchema} [page]
+ * @typedef UserPhoneNumbers
+ * @property {boolean} [active]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ * @property {string} [phone]
+ * @property {string} [country_code]
  */
 /**
- * @typedef UserGroupResponseSchema
- * @property {number} [__v]
- * @property {string} [_id]
+ * @typedef UserSchema
  * @property {string} [application_id]
- * @property {Conditions[]} [conditions]
- * @property {string} [created_at]
- * @property {string} [description]
- * @property {UserResponseErrorSchema} [error]
- * @property {string} [file_url]
- * @property {boolean} [is_active]
- * @property {string} [modified_at]
- * @property {string} [name]
- * @property {string} [status]
- * @property {string} [type]
- * @property {number} [uid]
- */
-/**
- * @typedef UserGroupUpdateData
- * @property {string} action
- * @property {string} [email] - Email of registered user
- * @property {string} [phone_number] - Phone number of registered user
- * @property {string} [user_id] - Must be valid mongodb objectid of existing user
- */
-/**
- * @typedef UserPhoneNumbers
+ * @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]
  * @property {boolean} [active]
- * @property {string} [country_code]
- * @property {string} [phone]
- * @property {boolean} [primary]
- * @property {boolean} [verified]
- */
-/**
- * @typedef UserResponseErrorSchema
- * @property {number} [count]
- * @property {string} [file_url]
- */
-/**
- * @typedef UserSchema
- * @property {string} [_id]
+ * @property {string} [profile_pic_url]
+ * @property {string} [username]
  * @property {string} [account_type]
- * @property {boolean} [active]
- * @property {string} [application_id]
+ * @property {string} [_id]
  * @property {string} [created_at]
- * @property {string} [dob]
- * @property {Email[]} [emails]
+ * @property {string} [updated_at]
  * @property {string} [external_id]
+ */
+/**
+ * @typedef UserSearchSchema
+ * @property {string} [application_id]
+ * @property {string} [user_id]
  * @property {string} [first_name]
- * @property {string} [gender]
- * @property {string} [last_name]
  * @property {Object} [meta]
+ * @property {string} [last_name]
  * @property {PhoneNumber[]} [phone_numbers]
+ * @property {Email[]} [emails]
+ * @property {string} [gender]
+ * @property {string} [dob]
+ * @property {boolean} [active]
  * @property {string} [profile_pic_url]
- * @property {string} [updated_at]
- * @property {string} [user_id]
  * @property {string} [username]
+ * @property {string} [account_type]
+ * @property {string} [_id]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ * @property {string} [external_id]
+ * @property {boolean} [archive]
+ * @property {string} [status]
  */
 /**
- * @typedef UserSearchResponseSchema
- * @property {UserSchema[]} [users]
+ * @typedef PhoneNumber
+ * @property {boolean} [active]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ * @property {string} [phone]
+ * @property {number} [country_code]
+ */
+/**
+ * @typedef Email
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ * @property {string} [email]
+ * @property {boolean} [active]
  */
 declare class UserPlatformModel {
 }
 declare namespace UserPlatformModel {
-    export { Accountkit, ArchiveUserRequestSchema, ArchiveUserSuccess, AuthenticationApiErrorSchema, BlockUserRequestSchema, BlockUserSuccess, Conditions, ConditionsSchema, CreateUserAttributeDefinition, CreateUserAttributeRequest, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, CustomerListResponseSchema, DeleteAccountConsent, DeleteAccountReasons, Email, Facebook, FlashCard, Google, Login, LookAndFeel, MetaSchema, PaginationSchema, PartialUserGroupUpdateSchema, PhoneNumber, PlatformEmail, PlatformMobile, PlatformSchema, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, RequiredFields, SessionDeleteResponseSchema, SessionExpiry, SessionListResponseInfo, SessionListResponseSchema, SessionsDeleteResponseSchema, Social, SocialTokens, SuccessMessageResponse, UnDeleteUserRequestSchema, UnDeleteUserSuccess, UpdateUserGroupSchema, UpdateUserRequestSchema, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, UserEmails, UserGroupListResponseSchema, UserGroupResponseSchema, UserGroupUpdateData, UserPhoneNumbers, UserResponseErrorSchema, UserSchema, UserSearchResponseSchema };
+    export { SuccessMessageResponse, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, CreateUserAttributeRequest, CreateUserAttributeDefinition, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
 }
-/** @returns {Accountkit} */
-declare function Accountkit(): Accountkit;
-type Accountkit = {
-    app_id?: string;
+/** @returns {SuccessMessageResponse} */
+declare function SuccessMessageResponse(): SuccessMessageResponse;
+type SuccessMessageResponse = {
+    success?: string;
 };
-/** @returns {ArchiveUserRequestSchema} */
-declare function ArchiveUserRequestSchema(): ArchiveUserRequestSchema;
-type ArchiveUserRequestSchema = {
+/** @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;
+    /**
+     * - Whether the attribute supports multiple values.
+     */
+    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;
+};
+/** @returns {UserAttributeDefinitionResponse} */
+declare function UserAttributeDefinitionResponse(): UserAttributeDefinitionResponse;
+type UserAttributeDefinitionResponse = {
+    /**
+     * - 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;
+    /**
+     * - Whether the attribute supports multiple values.
+     */
+    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 {UserAttributeDefinitionValidation} */
+declare function UserAttributeDefinitionValidation(): UserAttributeDefinitionValidation;
+type UserAttributeDefinitionValidation = {
+    /**
+     * - The type of validation.
+     */
+    type?: string;
+    /**
+     * - The validation value.
+     */
+    value?: any;
+};
+/** @returns {UserAttributeResponse} */
+declare function UserAttributeResponse(): UserAttributeResponse;
+type UserAttributeResponse = {
+    /**
+     * - 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 attribute type.
+     */
+    type?: string;
+    /**
+     * - Whether the attribute is customer-editable.
+     */
+    customer_overriden?: boolean;
+    attribute?: any;
+    updated_by?: string;
 };
-/** @returns {ArchiveUserSuccess} */
-declare function ArchiveUserSuccess(): ArchiveUserSuccess;
-type ArchiveUserSuccess = {
-    success?: boolean;
+/** @returns {CreateUserAttributeRequest} */
+declare function CreateUserAttributeRequest(): CreateUserAttributeRequest;
+type CreateUserAttributeRequest = {
+    customer_overriden?: boolean;
+    attribute?: any;
 };
-/** @returns {AuthenticationApiErrorSchema} */
-declare function AuthenticationApiErrorSchema(): AuthenticationApiErrorSchema;
-type AuthenticationApiErrorSchema = {
-    message?: string;
+/** @returns {CreateUserAttributeDefinition} */
+declare function CreateUserAttributeDefinition(): CreateUserAttributeDefinition;
+type CreateUserAttributeDefinition = {
+    name?: string;
+    slug?: string;
+    description?: string;
+    type?: string;
+    multi_value?: boolean;
+    customer_editable?: boolean;
+    encrypted?: boolean;
+    pinned?: boolean;
+    pin_order?: number;
+    default_value?: string;
+    validations?: any[];
 };
 /** @returns {BlockUserRequestSchema} */
 declare function BlockUserRequestSchema(): BlockUserRequestSchema;
 type BlockUserRequestSchema = {
-    reason?: string;
     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?: UserSchema[];
+    page?: PaginationSchema;
+};
+/** @returns {PaginationSchema} */
+declare function PaginationSchema(): PaginationSchema;
+type PaginationSchema = {
+    size?: number;
+    item_total?: number;
+    has_next?: boolean;
+    type?: string;
+    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 = {
-    key?: string;
-    type?: string;
     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 = {
-    type?: string;
     user_attribute_definition_id?: string;
-    value?: string;
-};
-/** @returns {CreateUserAttributeDefinition} */
-declare function CreateUserAttributeDefinition(): CreateUserAttributeDefinition;
-type CreateUserAttributeDefinition = {
-    customer_editable?: boolean;
-    default_value?: string;
-    description?: string;
-    encrypted?: boolean;
-    multi_value?: boolean;
-    name?: string;
-    pin_order?: number;
-    pinned?: boolean;
-    slug?: string;
     type?: string;
-    validations?: any[];
-};
-/** @returns {CreateUserAttributeRequest} */
-declare function CreateUserAttributeRequest(): CreateUserAttributeRequest;
-type CreateUserAttributeRequest = {
-    attribute?: any;
-    customer_overriden?: boolean;
+    value?: string;
 };
 /** @returns {CreateUserGroup} */
 declare function CreateUserGroup(): CreateUserGroup;
 type CreateUserGroup = {
     conditions?: ConditionsSchema[];
+    type?: string;
+    name: string;
     description: string;
     file_url?: string;
-    name: string;
-    type?: string;
 };
 /** @returns {CreateUserRequestSchema} */
 declare function CreateUserRequestSchema(): CreateUserRequestSchema;
 type CreateUserRequestSchema = {
+    phone_number: string;
     email?: string;
-    external_id?: string;
     first_name?: string;
-    gender?: string;
     last_name?: string;
-    meta?: any;
-    phone_number: string;
+    gender?: string;
     username: string;
+    meta?: any;
+    external_id?: string;
 };
 /** @returns {CreateUserResponseSchema} */
 declare function CreateUserResponseSchema(): CreateUserResponseSchema;
@@ -543,113 +851,72 @@ type CreateUserSessionRequestSchema = {
 /** @returns {CreateUserSessionResponseSchema} */
 declare function CreateUserSessionResponseSchema(): CreateUserSessionResponseSchema;
 type CreateUserSessionResponseSchema = {
-    cookie?: any;
     domain?: string;
-    http_only?: boolean;
     max_age?: number;
     secure?: boolean;
+    http_only?: boolean;
+    cookie?: any;
 };
-/** @returns {CustomerListResponseSchema} */
-declare function CustomerListResponseSchema(): CustomerListResponseSchema;
-type CustomerListResponseSchema = {
-    items?: UserSchema[];
-    page?: PaginationSchema;
-};
-/** @returns {DeleteAccountConsent} */
-declare function DeleteAccountConsent(): DeleteAccountConsent;
-type DeleteAccountConsent = {
-    consent_text?: string;
-};
-/** @returns {DeleteAccountReasons} */
-declare function DeleteAccountReasons(): DeleteAccountReasons;
-type DeleteAccountReasons = {
-    reason_id?: string;
-    reason_text?: string;
-    show_text_area?: boolean;
-};
-/** @returns {Email} */
-declare function Email(): Email;
-type Email = {
+/** @returns {PlatformSchema} */
+declare function PlatformSchema(): PlatformSchema;
+type PlatformSchema = {
+    display?: string;
+    look_and_feel?: LookAndFeel;
+    updated_at?: string;
     active?: boolean;
-    email?: string;
-    primary?: boolean;
-    verified?: boolean;
-};
-/** @returns {Facebook} */
-declare function Facebook(): Facebook;
-type Facebook = {
-    app_id?: string;
-};
-/** @returns {FlashCard} */
-declare function FlashCard(): FlashCard;
-type FlashCard = {
-    background_color?: string;
-    text?: string;
-    text_color?: string;
-};
-/** @returns {Google} */
-declare function Google(): Google;
-type Google = {
-    app_id?: string;
-};
-/** @returns {Login} */
-declare function Login(): Login;
-type Login = {
-    otp?: boolean;
-    password?: 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 = {
-    background_color?: string;
     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 {PaginationSchema} */
-declare function PaginationSchema(): PaginationSchema;
-type PaginationSchema = {
-    current?: number;
-    has_next?: boolean;
-    item_total?: number;
-    size?: number;
-    type?: string;
-};
-/** @returns {PartialUserGroupUpdateSchema} */
-declare function PartialUserGroupUpdateSchema(): PartialUserGroupUpdateSchema;
-type PartialUserGroupUpdateSchema = {
-    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;
-    name?: string;
-    /**
-     * - Source of update to be used to update individual
-     * users. Default value is considered file_url if not passed.
-     */
-    type?: 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 {Social} */
+declare function Social(): Social;
+type Social = {
+    account_kit?: boolean;
+    facebook?: boolean;
+    google?: boolean;
+    apple?: boolean;
 };
-/** @returns {PhoneNumber} */
-declare function PhoneNumber(): PhoneNumber;
-type PhoneNumber = {
-    active?: boolean;
-    country_code?: number;
-    phone?: string;
-    primary?: boolean;
-    verified?: boolean;
+/** @returns {RequiredFields} */
+declare function RequiredFields(): RequiredFields;
+type RequiredFields = {
+    email?: PlatformEmail;
+    mobile?: PlatformMobile;
 };
 /** @returns {PlatformEmail} */
 declare function PlatformEmail(): PlatformEmail;
@@ -663,35 +930,6 @@ type PlatformMobile = {
     is_required?: boolean;
     level?: string;
 };
-/** @returns {PlatformSchema} */
-declare function PlatformSchema(): PlatformSchema;
-type PlatformSchema = {
-    _id?: string;
-    active?: boolean;
-    created_at?: string;
-    delete_account_consent?: any;
-    delete_account_day?: number;
-    delete_account_reasons?: DeleteAccountReasons[];
-    desktop_image?: string;
-    display?: string;
-    flash_card?: FlashCard;
-    forgot_password?: boolean;
-    login?: Login;
-    look_and_feel?: LookAndFeel;
-    meta?: MetaSchema;
-    mobile_image?: string;
-    name?: string;
-    register?: boolean;
-    register_required_fields?: RegisterRequiredFields;
-    required_fields?: RequiredFields;
-    session_config?: any;
-    skip_captcha?: boolean;
-    skip_login?: boolean;
-    social?: Social;
-    social_tokens?: SocialTokens;
-    subtext?: string;
-    updated_at?: string;
-};
 /** @returns {RegisterRequiredFields} */
 declare function RegisterRequiredFields(): RegisterRequiredFields;
 type RegisterRequiredFields = {
@@ -710,361 +948,193 @@ type RegisterRequiredFieldsMobile = {
     is_required?: boolean;
     level?: string;
 };
-/** @returns {RequiredFields} */
-declare function RequiredFields(): RequiredFields;
-type RequiredFields = {
-    email?: PlatformEmail;
-    mobile?: PlatformMobile;
-};
-/** @returns {SessionDeleteResponseSchema} */
-declare function SessionDeleteResponseSchema(): SessionDeleteResponseSchema;
-type SessionDeleteResponseSchema = {
-    session_id?: string;
-    user_id?: string;
-};
-/** @returns {SessionExpiry} */
-declare function SessionExpiry(): SessionExpiry;
-type SessionExpiry = {
-    duration?: number;
-    is_rolling?: boolean;
-    type?: string;
-};
-/** @returns {SessionListResponseInfo} */
-declare function SessionListResponseInfo(): SessionListResponseInfo;
-type SessionListResponseInfo = {
-    domain?: string;
-    expire_in?: string;
-    ip?: string;
-    session_id?: string;
-    user_agent?: string;
-};
-/** @returns {SessionListResponseSchema} */
-declare function SessionListResponseSchema(): SessionListResponseSchema;
-type SessionListResponseSchema = {
-    items?: SessionListResponseInfo[];
-};
-/** @returns {SessionsDeleteResponseSchema} */
-declare function SessionsDeleteResponseSchema(): SessionsDeleteResponseSchema;
-type SessionsDeleteResponseSchema = {
-    session_ids?: string[];
-    user_id?: string;
-};
-/** @returns {Social} */
-declare function Social(): Social;
-type Social = {
-    account_kit?: boolean;
-    apple?: boolean;
-    facebook?: boolean;
-    google?: boolean;
+/** @returns {FlashCard} */
+declare function FlashCard(): FlashCard;
+type FlashCard = {
+    text?: string;
+    text_color?: string;
+    background_color?: string;
 };
 /** @returns {SocialTokens} */
 declare function SocialTokens(): SocialTokens;
 type SocialTokens = {
-    account_kit?: Accountkit;
     facebook?: Facebook;
+    accountkit?: Accountkit;
     google?: Google;
 };
-/** @returns {SuccessMessageResponse} */
-declare function SuccessMessageResponse(): SuccessMessageResponse;
-type SuccessMessageResponse = {
-    success?: string;
-};
-/** @returns {UnDeleteUserRequestSchema} */
-declare function UnDeleteUserRequestSchema(): UnDeleteUserRequestSchema;
-type UnDeleteUserRequestSchema = {
-    reason?: string;
+/** @returns {DeleteAccountReasons} */
+declare function DeleteAccountReasons(): DeleteAccountReasons;
+type DeleteAccountReasons = {
+    reason_text?: string;
     reason_id?: string;
-    user_id?: string;
+    show_text_area?: boolean;
 };
-/** @returns {UnDeleteUserSuccess} */
-declare function UnDeleteUserSuccess(): UnDeleteUserSuccess;
-type UnDeleteUserSuccess = {
-    success?: boolean;
+/** @returns {DeleteAccountConsent} */
+declare function DeleteAccountConsent(): DeleteAccountConsent;
+type DeleteAccountConsent = {
+    consent_text?: string;
 };
-/** @returns {UpdateUserGroupSchema} */
-declare function UpdateUserGroupSchema(): UpdateUserGroupSchema;
-type UpdateUserGroupSchema = {
-    conditions?: ConditionsSchema[];
-    description?: string;
-    file_url?: string;
-    name?: string;
-    type?: string;
+/** @returns {Facebook} */
+declare function Facebook(): Facebook;
+type Facebook = {
+    app_id?: string;
+    app_secret?: string;
 };
-/** @returns {UpdateUserRequestSchema} */
-declare function UpdateUserRequestSchema(): UpdateUserRequestSchema;
-type UpdateUserRequestSchema = {
-    emails?: UserEmails[];
-    external_id?: string;
-    first_name?: string;
-    gender?: string;
-    last_name?: string;
-    meta?: any;
-    phone_numbers?: UserPhoneNumbers[];
+/** @returns {Accountkit} */
+declare function Accountkit(): Accountkit;
+type Accountkit = {
+    app_id?: string;
+    app_secret?: string;
 };
-/** @returns {UserAttributeDefinition} */
-declare function UserAttributeDefinition(): UserAttributeDefinition;
-type UserAttributeDefinition = {
-    /**
-     * - The version number of the attribute.
-     */
-    __v?: number;
-    /**
-     * - The unique identifier for the attribute definition.
-     */
-    _id?: string;
-    /**
-     * - The application ID.
-     */
-    application_id?: string;
-    /**
-     * - The creation date of the attribute.
-     */
-    created_at?: string;
-    /**
-     * - Whether the attribute is customer-editable.
-     */
-    customer_editable?: boolean;
-    /**
-     * - The description of the attribute.
-     */
-    description?: string;
-    /**
-     * - Whether the attribute is encrypted.
-     */
-    encrypted?: boolean;
-    /**
-     * - Whether the attribute is locked.
-     */
-    is_locked?: boolean;
-    /**
-     * - The modification date of the attribute.
-     */
-    modified_at?: string;
-    /**
-     * - Whether the attribute supports multiple values.
-     */
-    multi_value?: boolean;
-    /**
-     * - The attribute name.
-     */
-    name?: string;
-    /**
-     * - The order in which the attribute is pinned.
-     */
-    pin_order?: number;
-    /**
-     * - Whether the attribute is pinned.
-     */
-    pinned?: boolean;
-    /**
-     * - The attribute key.
-     */
-    slug?: string;
-    /**
-     * - The attribute type.
-     */
-    type?: string;
-    validations?: any[];
+/** @returns {Google} */
+declare function Google(): Google;
+type Google = {
+    app_id?: string;
+    app_secret?: string;
 };
-/** @returns {UserAttributeDefinitionResponse} */
-declare function UserAttributeDefinitionResponse(): UserAttributeDefinitionResponse;
-type UserAttributeDefinitionResponse = {
-    /**
-     * - The unique identifier for the attribute definition.
-     */
-    _id?: string;
-    /**
-     * - The application ID.
-     */
-    application_id?: string;
-    /**
-     * - The creation date of the attribute definition.
-     */
-    created_at?: string;
-    /**
-     * - The user who created the attribute.
-     */
-    created_by?: string;
-    /**
-     * - Whether the attribute is customer-editable.
-     */
-    customer_editable?: boolean;
-    /**
-     * - The description of the attribute.
-     */
-    description?: string;
-    /**
-     * - Whether the attribute is encrypted.
-     */
-    encrypted?: boolean;
-    /**
-     * - Whether the attribute is locked.
-     */
-    is_locked?: boolean;
-    /**
-     * - The last modification date of the
-     * attribute definition.
-     */
-    modified_at?: string;
-    /**
-     * - Whether the attribute supports multiple values.
-     */
-    multi_value?: boolean;
-    /**
-     * - The attribute name.
-     */
-    name?: string;
-    /**
-     * - The order in which the attribute is pinned.
-     */
-    pin_order?: number;
-    /**
-     * - Whether the attribute is pinned.
-     */
-    pinned?: boolean;
-    /**
-     * - The attribute key.
-     */
-    slug?: string;
-    /**
-     * - The attribute type.
-     */
+/** @returns {SessionExpiry} */
+declare function SessionExpiry(): SessionExpiry;
+type SessionExpiry = {
+    duration?: number;
     type?: string;
-    /**
-     * - The user who last updated the attribute.
-     */
-    updated_by?: string;
-    validations?: UserAttributeDefinitionValidation[];
+    is_rolling?: boolean;
 };
-/** @returns {UserAttributeDefinitionValidation} */
-declare function UserAttributeDefinitionValidation(): UserAttributeDefinitionValidation;
-type UserAttributeDefinitionValidation = {
-    /**
-     * - The type of validation.
-     */
+/** @returns {UpdateUserGroupSchema} */
+declare function UpdateUserGroupSchema(): UpdateUserGroupSchema;
+type UpdateUserGroupSchema = {
+    conditions?: ConditionsSchema[];
     type?: string;
-    /**
-     * - The validation value.
-     */
-    value?: any;
+    name?: string;
+    description?: string;
+    file_url?: string;
 };
-/** @returns {UserAttributeResponse} */
-declare function UserAttributeResponse(): UserAttributeResponse;
-type UserAttributeResponse = {
+/** @returns {PartialUserGroupUpdateSchema} */
+declare function PartialUserGroupUpdateSchema(): PartialUserGroupUpdateSchema;
+type PartialUserGroupUpdateSchema = {
     /**
-     * - The unique identifier for the attribute definition.
+     * - Source of update to be used to update individual
+     * users. Default value is considered file_url if not passed.
      */
-    _id?: string;
+    type?: string;
+    name?: string;
+    description?: string;
     /**
-     * - The application ID.
+     * - 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.
      */
-    application_id?: string;
-    attribute?: any;
+    file_url?: string;
     /**
-     * - Whether the attribute is customer-editable.
+     * - 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
      */
-    customer_overriden?: boolean;
+    user_data?: UserGroupUpdateData[];
+};
+/** @returns {UserGroupUpdateData} */
+declare function UserGroupUpdateData(): UserGroupUpdateData;
+type UserGroupUpdateData = {
     /**
-     * - The name of user attribute definition.
+     * - Must be valid mongodb objectid of existing user
      */
-    name?: string;
+    user_id?: string;
     /**
-     * - The attribute type.
+     * - Phone number of registered user
      */
-    type?: string;
-    updated_by?: string;
+    phone_number?: string;
     /**
-     * - The unique identifier for the user.
+     * - Email of registered user
      */
-    user_id?: string;
+    email?: string;
+    action: string;
+};
+/** @returns {UpdateUserRequestSchema} */
+declare function UpdateUserRequestSchema(): UpdateUserRequestSchema;
+type UpdateUserRequestSchema = {
+    first_name?: string;
+    last_name?: string;
+    gender?: string;
+    external_id?: string;
+    meta?: any;
+    phone_numbers?: UserPhoneNumbers[];
+    emails?: UserEmails[];
 };
 /** @returns {UserEmails} */
 declare function UserEmails(): UserEmails;
 type UserEmails = {
     active?: boolean;
-    email?: string;
     primary?: boolean;
     verified?: boolean;
-};
-/** @returns {UserGroupListResponseSchema} */
-declare function UserGroupListResponseSchema(): UserGroupListResponseSchema;
-type UserGroupListResponseSchema = {
-    items?: UserGroupResponseSchema[];
-    page?: PaginationSchema;
-};
-/** @returns {UserGroupResponseSchema} */
-declare function UserGroupResponseSchema(): UserGroupResponseSchema;
-type UserGroupResponseSchema = {
-    __v?: number;
-    _id?: string;
-    application_id?: string;
-    conditions?: Conditions[];
-    created_at?: string;
-    description?: string;
-    error?: UserResponseErrorSchema;
-    file_url?: string;
-    is_active?: boolean;
-    modified_at?: string;
-    name?: string;
-    status?: string;
-    type?: string;
-    uid?: number;
-};
-/** @returns {UserGroupUpdateData} */
-declare function UserGroupUpdateData(): UserGroupUpdateData;
-type UserGroupUpdateData = {
-    action: string;
-    /**
-     * - Email of registered user
-     */
     email?: string;
-    /**
-     * - Phone number of registered user
-     */
-    phone_number?: string;
-    /**
-     * - Must be valid mongodb objectid of existing user
-     */
-    user_id?: string;
 };
 /** @returns {UserPhoneNumbers} */
 declare function UserPhoneNumbers(): UserPhoneNumbers;
 type UserPhoneNumbers = {
     active?: boolean;
-    country_code?: string;
-    phone?: string;
     primary?: boolean;
     verified?: boolean;
-};
-/** @returns {UserResponseErrorSchema} */
-declare function UserResponseErrorSchema(): UserResponseErrorSchema;
-type UserResponseErrorSchema = {
-    count?: number;
-    file_url?: string;
+    phone?: string;
+    country_code?: string;
 };
 /** @returns {UserSchema} */
 declare function UserSchema(): UserSchema;
 type UserSchema = {
-    _id?: string;
-    account_type?: string;
-    active?: boolean;
     application_id?: string;
-    created_at?: string;
-    dob?: string;
-    emails?: Email[];
-    external_id?: string;
+    user_id?: string;
     first_name?: string;
-    gender?: string;
-    last_name?: string;
     meta?: any;
+    last_name?: string;
     phone_numbers?: PhoneNumber[];
+    emails?: Email[];
+    gender?: string;
+    dob?: string;
+    active?: boolean;
     profile_pic_url?: string;
+    username?: string;
+    account_type?: string;
+    _id?: string;
+    created_at?: string;
     updated_at?: string;
+    external_id?: string;
+};
+/** @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;
+    dob?: string;
+    active?: boolean;
+    profile_pic_url?: string;
     username?: string;
+    account_type?: string;
+    _id?: string;
+    created_at?: string;
+    updated_at?: string;
+    external_id?: string;
+    archive?: boolean;
+    status?: string;
 };
-/** @returns {UserSearchResponseSchema} */
-declare function UserSearchResponseSchema(): UserSearchResponseSchema;
-type UserSearchResponseSchema = {
-    users?: UserSchema[];
+/** @returns {PhoneNumber} */
+declare function PhoneNumber(): PhoneNumber;
+type PhoneNumber = {
+    active?: boolean;
+    primary?: boolean;
+    verified?: boolean;
+    phone?: string;
+    country_code?: number;
+};
+/** @returns {Email} */
+declare function Email(): Email;
+type Email = {
+    primary?: boolean;
+    verified?: boolean;
+    email?: string;
+    active?: boolean;
 };