@machb/user-entities v0.0.2-SNAPSHOT
@machb/user-entities / ContactInfo
Class: ContactInfo
Defined in: ContactInfo.ts:19
Represents a user's contact information as part of the domain entity.
The ContactInfo class serves as a model for storing and managing
user-specific contact details, such as physical address, name, job title,
and communication information. This class is designed for use within
the @machb/user-entities library and can be utilized for various
user-related workflows across applications.
Usage
const contactInfo = new ContactInfo();
contactInfo.firstName = "John";
contactInfo.lastName = "Doe";
contactInfo.phoneNumber = "+1-234-567-8901";
contactInfo.address1 = "123 Main St";
Constructors
Constructor
new ContactInfo():
ContactInfo
Returns
ContactInfo
Properties
address1
address1:
string|null=null
Defined in: ContactInfo.ts:29
Primary address line (e.g., house number and street).
address2
address2:
string|null=null
Defined in: ContactInfo.ts:34
Secondary address line (e.g., apartment, suite, or unit).
address3
address3:
string|null=null
Defined in: ContactInfo.ts:39
Additional address line (e.g., PO box or other information).
city
city:
string|null=null
Defined in: ContactInfo.ts:44
The city associated with the contact information.
companyName
companyName:
string|null=null
Defined in: ContactInfo.ts:49
The name of the company, if the contact is associated with an organization.
country
country:
string|null=null
Defined in: ContactInfo.ts:54
The country for the contact's address.
county
county:
string|null=null
Defined in: ContactInfo.ts:59
The county or region for the contact's address.
faxNumber
faxNumber:
string|null=null
Defined in: ContactInfo.ts:64
The fax number associated with the contact.
firstName
firstName:
string|null=null
Defined in: ContactInfo.ts:69
The first name of the contact person.
id
id:
string|null=null
Defined in: ContactInfo.ts:24
Unique identifier for the contact information. Typically used internally to reference this entity in a database or other storage.
jobTitle
jobTitle:
string|null=null
Defined in: ContactInfo.ts:74
The contact's job title, if applicable (e.g., "Software Engineer").
lastName
lastName:
string|null=null
Defined in: ContactInfo.ts:79
The last name of the contact person.
middleName
middleName:
string|null=null
Defined in: ContactInfo.ts:84
The middle name or initial of the contact person.
ownerId
ownerId:
string|null=null
Defined in: ContactInfo.ts:89
The unique identifier of the contact's owner (e.g., a user ID or account owner ID).
phoneNumber
phoneNumber:
string|null=null
Defined in: ContactInfo.ts:94
The contact's primary phone number.
postalCode
postalCode:
string|null=null
Defined in: ContactInfo.ts:99
The postal/ZIP code associated with this contact information.
prefix
prefix:
string|null=null
Defined in: ContactInfo.ts:104
The contact's name prefix (e.g., "Dr.", "Mr.", or "Ms.").
state
state:
string|null=null
Defined in: ContactInfo.ts:109
The state, province, or administrative region of the contact's address.
suffix
suffix:
string|null=null
Defined in: ContactInfo.ts:114
The contact's name suffix (e.g., "Jr.", "Sr.", "III").