datasquirel/types/user.td.js

50 lines
1.7 KiB
JavaScript
Raw Normal View History

2023-09-21 14:00:04 +00:00
/**
* @typedef {object} DATASQUIREL_LoggedInUser
2024-07-13 07:31:10 +00:00
* @property {number} [id]
* @property {string} first_name
* @property {string} last_name
* @property {string} email
* @property {string} [phone]
* @property {string} [user_type]
* @property {string} [username]
* @property {string} password
* @property {string} [image]
* @property {string} [image_thumbnail]
* @property {string} [address]
* @property {string} [city]
* @property {string} [state]
* @property {string} [country]
* @property {string} [zip_code]
* @property {number} [social_login]
* @property {string?} [social_platform]
* @property {string?} [social_id]
* @property {string} [more_user_data]
* @property {number} [verification_status]
* @property {number?} [loan_officer_id]
* @property {number} [is_admin]
* @property {number} [admin_level]
* @property {string} [admin_permissions]
* @property {string?} uuid
* @property {string?} [temp_login_code]
* @property {string?} [date_created]
* @property {number?} [date_created_code]
* @property {string?} [date_created_timestamp]
* @property {string?} [date_updated]
* @property {number?} [date_updated_code]
* @property {string?} [date_updated_timestamp]
2024-07-13 07:35:28 +00:00
* @property {string} [csrf_k] - CSRF key
2024-07-13 07:35:21 +00:00
* @property {boolean} [logged_in_status]
2024-07-13 19:53:14 +00:00
* @property {number} [date]
* @property {any} [more_data]
2023-09-21 14:00:04 +00:00
*/
2024-10-11 09:01:17 +00:00
/**
* @typedef {object} AuthenticatedUser
* @property {boolean} success - Did the function run successfully?
* @property {import("../types/user.td").DATASQUIREL_LoggedInUser | null} payload - Payload of the response
* @property {string} [msg] - An optional message
* @property {number} [userId] - An optional message
*/
module.exports = { DATASQUIREL_LoggedInUser, AuthenticatedUser };